apollo-state-sync - API Reference (Users)
    Preparing search index...

    Type Alias SetRVarSyncedOptionsType

    Configuration options passed when updating a synced reactive variable.

    type SetRVarSyncedOptionsType = {
        doNotBroadcast?: boolean;
        doNotPersist?: boolean;
        isSubscriptionRes?: boolean;
    }
    Index
    doNotBroadcast? doNotPersist? isSubscriptionRes?
    doNotBroadcast?: boolean

    Disables broadcasting the update to other browsing contexts.

    false
    doNotPersist?: boolean

    Prevents the Apollo Client's state from being persisted during this update.

    false
    isSubscriptionRes?: boolean

    Indicates if the update is a response to a GraphQL subscription.

    When true, this prevents redundant broadcasts because the WebSocket connection directly notifies other browsing contexts.

    false

    excalidraw diagram

    Settings
    Member Visibility

    On This Page
    Properties