@dxos/react-client
    Preparing search index...

    Interface Queue<T>

    Client-side view onto an EDGE queue.

    interface Queue<T extends Entity.Unknown = Entity.Unknown> {
        dxn: DXN;
        error: null | Error;
        isLoading: boolean;
        objects: T[];
        query: QueryFn;
        append(objects: T[]): Promise<void>;
        delete(ids: string[]): Promise<void>;
        getObjectsById(ids: string[]): Promise<(undefined | T)[]>;
        queryObjects(): Promise<T[]>;
        refresh(): Promise<void>;
        subscribe(callback: () => void): () => void;
        sync(
            request?: { shouldPull?: boolean; shouldPush?: boolean },
        ): Promise<void>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    dxn error isLoading objects query

    Methods

    append delete getObjectsById queryObjects refresh subscribe sync

    Properties

    dxn: DXN
    error: null | Error

    Use query() API instead.

    isLoading: boolean

    Use query() API instead.

    objects: T[]

    Use query() API instead.

    query: QueryFn

    Methods

    • Appends objects to the queue.

      Parameters

      • objects: T[]

      Returns Promise<void>

    • Deletes objects from the queue.

      Parameters

      • ids: string[]

      Returns Promise<void>

    • Queries objects by id.

      Parameters

      • ids: string[]

      Returns Promise<(undefined | T)[]>

      Use query() API instead.

    • Query all objects in the queue.

      Returns Promise<T[]>

      Use query() API instead.

    • Refreshes the queue from the server.

      Returns Promise<void>

      Use query() API instead.

    • Subscribe to queue updates.

      Parameters

      • callback: () => void

      Returns () => void

      Unsubscribe function.

    • Syncs the queue with the server.

      Parameters

      • Optionalrequest: { shouldPull?: boolean; shouldPush?: boolean }

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods