Type Alias ListQueryOptions<T>

ListQueryOptions: {
    limit?: number;
    populate?: PopulateOptions<T>[];
    select?: SelectQuery<T>[];
    skip?: number;
    sort?: string | Record<string, SortOrder>;
}

Options for List Query.

Type Parameters

  • T

Type declaration

  • Optionallimit?: number

    Specifies the maximum number of records the query will return.

  • Optionalpopulate?: PopulateOptions<T>[]

    Allows to populate referenced documents using a collection

  • Optionalselect?: SelectQuery<T>[]

    Specifies the fields to select

  • Optionalskip?: number

    Specifies the number of records to skip

  • Optionalsort?: string | Record<string, SortOrder>

    Sets the sort order

Settings

Member Visibility