@truenas/api-client
    Preparing search index...

    Interface QueryOptions<T>

    interface QueryOptions<T> {
        count?: boolean;
        extra?: Record<string, unknown>;
        force_sql_filters?: boolean;
        get?: boolean;
        limit?: number;
        offset?: number;
        order_by?: string[];
        select?: v25_10_0.QueryFilterField<T>[];
    }

    Type Parameters

    • T
    Index
    count? extra? force_sql_filters? get? limit? offset? order_by? select?
    count?: boolean

    Return the number of matching entries instead of the entries.

    extra?: Record<string, unknown>

    Method-specific extra options (see the method's API documentation).

    force_sql_filters?: boolean
    get?: boolean

    Return the single matching entry; an error unless exactly one matches.

    limit?: number

    Return at most this many entries.

    offset?: number

    Skip this many entries.

    order_by?: string[]

    Sort by these fields, in order. Prefix a field with '-' for descending; 'nulls_first:' / 'nulls_last:' prefixes control NULL placement.

    select?: v25_10_0.QueryFilterField<T>[]

    Return only these fields. Dotted paths select nested values.

    Settings
    Member Visibility

    On This Page
    Properties