HistoryBridgeFunctions

Async bridge functions forwarded via comlink from the iframe (FrameWrapper) to the parent window (HostIframe). All methods are async because they cross the comlink boundary.

Callbacks that cross the boundary (addBlock) must be wrapped with comlink.proxy() by the caller (FrameWrapper.init) before being passed in.

Index

Methods

• addBlock
• navigate
• setActiveChild
• setHash
• setParams
• setRoute
• setSegmentCount
• setState

Methods

addBlock

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

• Callback must be wrapped with comlink.proxy by FrameWrapper. Returns an async unsubscribe fn.

  ---

  Parameters

  • callback: () => Promise<boolean>

  • optionalopts: ChaynsHistoryBlockOptions

  Returns Promise<() => void>

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): Promise<void>

• Parameters

  • hash: string

  • optionalopts: ChaynsHistoryNavigationCommitOptions

  Returns Promise<void>

setParams

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

• Parameters

  • params: Record<string, string>

  • optionalopts: ChaynsHistoryNavigationCommitOptions

  Returns Promise<void>

setRoute

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

• Parameters

  • route: string | string[]

  • optionalopts: ChaynsHistoryNavigateOptions

  Returns Promise<void>

setSegmentCount

• setSegmentCount(n: number): Promise<void>

• Parameters

  • n: number

  Returns Promise<void>

setState

• setState(state: Record<string, unknown>, opts?: ChaynsHistoryNavigateOptions): Promise<void>

• Parameters

  • state: Record<string, unknown>

  • optionalopts: ChaynsHistoryNavigateOptions

  Returns Promise<void>