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

    Interface Queue<T>

    Client-side view onto an EDGE queue.

    interface Queue<T extends Obj.Any | Relation.Any = Obj.Any | Relation.Any> {
        dxn: DXN;
        error: null | Error;
        isLoading: boolean;
        objects: T[];
        append(objects: T[]): Promise<void>;
        delete(ids: string[]): Promise<void>;
        getObjectsById(ids: string[]): Promise<(null | T)[]>;
        queryObjects(): Promise<T[]>;
        refresh(): Promise<void>;
        toJSON(): any;
    }

    Type Parameters

    • T extends Obj.Any | Relation.Any = Obj.Any | Relation.Any
    Index

    Properties

    dxn error isLoading objects

    Methods

    append delete getObjectsById queryObjects refresh toJSON

    Properties

    dxn: DXN
    error: null | Error
    isLoading: boolean
    objects: T[]

    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<(null | T)[]>

    • Query all objects in the queue.

      Returns Promise<T[]>

    • Refreshes the queue from the server.

      Returns Promise<void>

    • Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods