Prometheus Entity Management API
    Preparing search index...

    Interface ListQuery

    Transport-agnostic list query passed by useEntities / useEntityQuery down to the registered transport.

    The transport is responsible for compiling this into the transport-specific wire format (HTTP query string, GraphQL variables, SQL WHERE, in-memory predicate, etc.).

    interface ListQuery {
        cursor?: string | number | null;
        filter?: FilterSpec | null;
        limit?: number;
        search?: string;
        signal?: AbortSignal;
        sort?: SortSpec | null;
    }
    Index
    cursor? filter? limit? search? signal? sort?
    cursor?: string | number | null

    Opaque cursor for pagination (cursor or numeric offset).

    filter?: FilterSpec | null

    Optional filter; transport-agnostic, see FilterSpec.

    limit?: number

    Page size hint. Transport may cap or ignore.

    search?: string

    Free-text search string; transport decides which fields to match.

    signal?: AbortSignal

    Aborts the request when fired. Transports MUST honour this.

    sort?: SortSpec | null

    Optional sort spec; transport-agnostic.

    Settings
    Member Visibility

    On This Page
    Properties