ChaynsHistoryLayer

Implemented by

• ChaynsHistoryLayerClass
• FrameHistoryLayer

Index

Properties

• depth
• id

Methods

• addBlock
• addEventListener
• createChildLayer
• destroyChildLayer
• getActiveChildId
• getChildLayer
• getHash
• getParams
• getRoute
• getSegmentCount
• getState
• navigate
• setActiveChild
• setHash
• setParams
• setRoute
• setSegmentCount
• setState

Properties

readonlydepth

depth: number

readonlyid

id: string

Methods

addBlock

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

• Parameters

  • callback: () => Promise<boolean>

  • optionalopts: ChaynsHistoryBlockOptions

  Returns () => void

  • • (): void

    • Returns void

addEventListener

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

• Parameters

  • type: popstate | change

  • handler: (e: ChaynsHistoryLayerEvent) => void

  Returns () => void

  • • (): void

    • Returns void

createChildLayer

• createChildLayer(id: string): ChaynsHistoryLayer

• Parameters

  • id: string

  Returns ChaynsHistoryLayer

destroyChildLayer

• destroyChildLayer(id: string): void

• Parameters

  • id: string

  Returns void

getActiveChildId

• getActiveChildId(): null | string

• Returns null | string

getChildLayer

• getChildLayer(id: string): undefined | ChaynsHistoryLayer

• Parameters

  • id: string

  Returns undefined | ChaynsHistoryLayer

getHash

• getHash(): string

• Returns string

getParams

• getParams(): Record<string, string>

• Returns Record<string, string>

getRoute

• getRoute(): string[]

• Returns string[]

getSegmentCount

• getSegmentCount(): number

• Returns number

getState

• getState<T>(): undefined | T

• 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>

• 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>

• Parameters

  • id: null | string

  • optionalinit: { route?: string | string[]; state?: Record<string, unknown> }

  • optionalroute: string | string[]

  • optionalstate: Record<string, unknown>

  Returns Promise<ChaynsHistoryActionResult>

setHash

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

• Parameters

  • hash: string

  • optionalopts: ChaynsHistoryNavigationCommitOptions

  Returns void

setParams

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

• Parameters

  • params: Record<string, string>

  • optionalopts: ChaynsHistoryNavigationCommitOptions

  Returns void

setRoute

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

• Parameters

  • route: string | string[]

  • optionalopts: ChaynsHistoryNavigateOptions

  Returns void

setSegmentCount

• setSegmentCount(n: number): void

• Parameters

  • n: number

  Returns void

setState

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

• Type parameters

  • T: object

  Parameters

  • state: T

  • optionalopts: ChaynsHistoryNavigateOptions

  Returns void