Interface StateAwareOptions<T>

Options for state-aware event subscriptions

interface StateAwareOptions<T> {
    getCurrentState: (() => T | Promise<T>);
    transformState?: ((state) => T);
    shouldUseFetchedState?: ((state) => boolean);
    timeout?: number;
}

Type Parameters

  • T

Properties

getCurrentState transformState? shouldUseFetchedState? timeout?

Properties

getCurrentState

getCurrentState: (() => T | Promise<T>)

Function to fetch the current state

Type declaration

    • (): T | Promise<T>

    • Returns T | Promise<T>

Optional transformState

transformState?: ((state) => T)

Optional transform function to normalize API response to event format

Type declaration

    • (state): T

    • Parameters

      • state: any

      Returns T

Optional shouldUseFetchedState

shouldUseFetchedState?: ((state) => boolean)

Optional function to determine if we should use the fetched state

Type declaration

    • (state): boolean

    • Parameters

      • state: T

      Returns boolean

Optional timeout

timeout?: number

Timeout for waiting for events (ms)

Settings

Member Visibility

Theme

On This Page

getCurrentStatetransformStateshouldUseFetchedStatetimeout