@dxos/client
    Preparing search index...

    Interface QueryOptions

    Defined in: file://./../../../dxos/echo/filter.proto

    interface QueryOptions {
        dataLocation?: DataLocation;
        deleted?: ShowDeletedOption;
        include?: Struct;
        limit?: number;
        models?: string[];
        spaceIds?: string[];
        spaces?: PublicKey[];
    }
    Index

    Properties

    dataLocation? deleted? include? limit? models? spaceIds? spaces?

    Properties

    dataLocation?: DataLocation

    Query only local spaces, or remote on agent.

    QueryOptions.DataLocation.LOCAL

    Options:

    • proto3_optional = true
    deleted?: ShowDeletedOption

    Controls how deleted items are filtered.

    Options:

    • proto3_optional = true
    include?: Struct

    References to inline when querying.

    Options:

    • proto3_optional = true
    limit?: number

    Return only first limit results.

    Options:

    • proto3_optional = true
    models?: string[]

    Filter by model.

    • Only DocumentModel. To querty all models, use models: ["*"].
    spaceIds?: string[]

    Query only in specific spaces.

    spaces?: PublicKey[]

    Query only in specific spaces.

    Use spaceIds instead.

    Settings

    Member Visibility

    On This Page

    Properties