Interface ConfigSyncInterface

Synchronization configuration interface This interface provides the options for configuring the synchronization of actions across multiple tabs.

Note: When using multiple options (predicate, blacklist, and whitelist), only one of them will be effective. The priority is predicate > blacklist > whitelist.

Hierarchy

  • ConfigSyncInterface

Properties

blacklist? channelName? initState? predicate? prepareState? whitelist?

Properties

Optional blacklist

blacklist?: string[]

Array of actions that will not be triggered in other tabs.

Optional channelName

channelName?: string

Name of the communication channel to use for action synchronization.

Optional initState

initState?: boolean

Flag indicating whether to copy the initial state from another tab (if available).

Optional predicate

predicate?: ((action: AnyAction) => boolean)

Type declaration

    • (action: AnyAction): boolean

    • A function to filter the actions to be synchronized based on custom criteria.

      Parameters

      • action: AnyAction

      Returns boolean

Optional prepareState

prepareState?: ((action: AnyAction) => any)

Type declaration

    • (action: AnyAction): any

    • A function to prepare the initial state for synchronization with other tabs.

      Parameters

      • action: AnyAction

      Returns any

Optional whitelist

whitelist?: string[]

Array of actions that will be triggered in other tabs.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc