@dxos/client
    Preparing search index...

    Interface Queue<T>

    Client-side view onto an EDGE queue.

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

    Type Parameters

    • T extends BaseEchoObject = BaseEchoObject
    Index

    Properties

    dxn error isLoading objects

    Methods

    append delete refresh toJSON

    Properties

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

    Methods

    • Appends objects to the queue.

      Parameters

      • objects: T[]

      Returns void

    • Deletes objects from the queue.

      Parameters

      • ids: string[]

      Returns void

    • Refreshes the queue from the server.

      Returns Promise<void>

    • Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods