BlockRegistry

Index

Constructors

• constructor

Methods

• add
• checkBlocks
• collectApplicableBlocks
• remove
• removeAllForLayer

Constructors

constructor

• new BlockRegistry(): BlockRegistry

• Returns BlockRegistry

Methods

add

• add(layer: ChaynsHistoryLayer, callback: () => Promise<boolean>, opts?: ChaynsHistoryBlockOptions): () => void

• Parameters

  • layer: ChaynsHistoryLayer

  • callback: () => Promise<boolean>

  • opts: ChaynsHistoryBlockOptions = {}

  Returns () => void

  • • (): void

    • Returns void

checkBlocks

• checkBlocks(targetLayer: ChaynsHistoryLayer): Promise<boolean>

• Runs all applicable block callbacks in parallel. Returns true if navigation is allowed (no block), false otherwise. Callbacks that throw or time out count as blocked (with dev-warn).

  ---

  Parameters

  • targetLayer: ChaynsHistoryLayer

  Returns Promise<boolean>

collectApplicableBlocks

• collectApplicableBlocks(targetLayer: ChaynsHistoryLayer): BlockEntry[]

• Collects all blocks applicable to a navigation targeting targetLayer.

  Rules:

  • local blocks: only those registered on targetLayer.
  • global blocks: those registered on targetLayer or any of its active-chain descendants (not inactive subtrees).

  ---

  Parameters

  • targetLayer: ChaynsHistoryLayer

  Returns BlockEntry[]

remove

• remove(layerId: string, entry: BlockEntry): void

• Parameters

  • layerId: string

  • entry: BlockEntry

  Returns void

removeAllForLayer

• removeAllForLayer(layerId: string): void

• Remove all blocks registered for a layer (called on destroy).

  ---

  Parameters

  • layerId: string

  Returns void