Skip to main content

ChaynsHistoryLayerClass

Implements

ChaynsHistoryLayer

Index

Constructors

constructor

new ChaynsHistoryLayerClass(init: ChaynsHistoryLayerInit): ChaynsHistoryLayer

Parameters
- init: ChaynsHistoryLayerInit
Returns ChaynsHistoryLayer

Properties

readonlydepth

depth: number

readonlyid

id: string

readonlyparent

parent: null | ChaynsHistoryLayer

Methods

addBlock

addBlock(callback: () => Promise<boolean>, opts?: ChaynsHistoryBlockOptions): () => void

Implementation of IChaynsHistoryLayer.addBlock
Parameters
- callback: () => Promise<boolean>
- opts: ChaynsHistoryBlockOptions = {}
Returns () => void
- - (): void
  - Returns void

addEventListener

addEventListener(type: popstate | change, handler: (e: ChaynsHistoryLayerEvent) => void): () => void

Implementation of IChaynsHistoryLayer.addEventListener
Parameters
- type: popstate | change
- handler: (e: ChaynsHistoryLayerEvent) => void
Returns () => void
- - (): void
  - Returns void

createChildLayer

createChildLayer(id: string): ChaynsHistoryLayer

Implementation of IChaynsHistoryLayer.createChildLayer
Parameters
- id: string
Returns ChaynsHistoryLayer

destroyChildLayer

destroyChildLayer(id: string): void

Implementation of IChaynsHistoryLayer.destroyChildLayer
Parameters
- id: string
Returns void

getActiveChildId

getActiveChildId(): null | string

Implementation of IChaynsHistoryLayer.getActiveChildId
Returns null | string

getChildLayer

getChildLayer(id: string): undefined | ChaynsHistoryLayer

Implementation of IChaynsHistoryLayer.getChildLayer
Parameters
- id: string
Returns undefined | ChaynsHistoryLayer

getHash

getHash(): string

Implementation of IChaynsHistoryLayer.getHash
Returns string

getParams

getParams(): Record<string, string>

Implementation of IChaynsHistoryLayer.getParams
Returns Record<string, string>

getRoute

getRoute(): string[]

Implementation of IChaynsHistoryLayer.getRoute
Returns string[]

getSegmentCount

getSegmentCount(): number

Implementation of IChaynsHistoryLayer.getSegmentCount
Returns number

getState

getState<T>(): undefined | T

Implementation of IChaynsHistoryLayer.getState
Type parameters
- T: object = Record<string, unknown>
Returns undefined | T

navigate

navigate(opts: { activeChild?: null | string; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigationCommitOptions & { hash?: string; params?: Record<string, string> }): Promise<ChaynsHistoryActionResult>

Implementation of IChaynsHistoryLayer.navigate
Parameters
- opts: { activeChild?: null | string; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigationCommitOptions & { hash?: string; params?: Record<string, string> }
Returns Promise<ChaynsHistoryActionResult>

setActiveChild

setActiveChild(id: null | string, init?: { route?: string | string[]; state?: Record<string, unknown> }): Promise<ChaynsHistoryActionResult>

Implementation of IChaynsHistoryLayer.setActiveChild
Parameters
- id: null | string
- optionalinit: { route?: string | string[]; state?: Record<string, unknown> }
Returns Promise<ChaynsHistoryActionResult>

setHash

setHash(hash: string, opts?: ChaynsHistoryNavigationCommitOptions): void

Implementation of IChaynsHistoryLayer.setHash
Parameters
- hash: string
- optionalopts: ChaynsHistoryNavigationCommitOptions
Returns void

setParams

setParams(params: Record<string, string>, opts?: ChaynsHistoryNavigationCommitOptions): void

Implementation of IChaynsHistoryLayer.setParams
Parameters
- params: Record<string, string>
- optionalopts: ChaynsHistoryNavigationCommitOptions
Returns void

setRoute

setRoute(route: string | string[], opts?: ChaynsHistoryNavigateOptions): void

Implementation of IChaynsHistoryLayer.setRoute
Parameters
- route: string | string[]
- optionalopts: ChaynsHistoryNavigateOptions
Returns void

setSegmentCount

setSegmentCount(n: number): void

Implementation of IChaynsHistoryLayer.setSegmentCount
Parameters
- n: number
Returns void

setState

setState<T>(state: T, opts?: ChaynsHistoryNavigateOptions): void

Implementation of IChaynsHistoryLayer.setState
Type parameters
- T: object
Parameters
- state: T
- optionalopts: ChaynsHistoryNavigateOptions
Returns void