@twilio/flex-sdk
    Preparing search index...

    Interface WriteQueryOptions<TData, TVariables>

    interface WriteQueryOptions<TData, TVariables extends OperationVariables> {
        broadcast?: boolean;
        data: TData;
        extensions?: Record<string, unknown>;
        id?: string;
        overwrite?: boolean;
        query: DocumentNode | TypedDocumentNode<TData, TVariables>;
        variables?: TVariables;
    }

    Type Parameters

    • TData
    • TVariables extends OperationVariables

    Hierarchy (View Summary)

    Index

    Properties

    broadcast? data extensions? id? overwrite? query variables?

    Properties

    broadcast?: boolean

    Whether to notify query watchers.

    true
    data: TData

    The data to write to the store.

    extensions?: Record<string, unknown>

    GraphQL extensions for the write operation. Any provided extensions are available in merge functions.

    id?: string

    The root id to be used. Defaults to "ROOT_QUERY", which is the ID of the root query object. This property makes writeQuery capable of writing data to any object in the cache.

    overwrite?: boolean

    When true, ignore existing field data rather than merging it with incoming data.

    false
    query: DocumentNode | TypedDocumentNode<TData, TVariables>

    The GraphQL query shape to be used constructed using the gql template string tag. The query will be used to determine the shape of the data to be read.

    variables?: TVariables

    Any variables that your GraphQL fragments depend on.

    Settings

    Member Visibility

    On This Page

    Properties