Interface QueryContract<DocumentType>

interface QueryContract<DocumentType> {
    "[asyncIterator]"(): AsyncIterableIterator<DocumentType, any, any>;
    all(): Promise<DocumentType[]>;
    count(): Promise<number>;
    distinct<T = unknown>(key: string): Promise<T[]>;
    explain(verbosity?: ExplainVerbosityLike): Promise<Document>;
    first(): Promise<null | DocumentType>;
    firstOrFail(): Promise<DocumentType>;
    limit(number: number): this;
    skip(number: number): this;
    sort(sort: QuerySortObject): this;
    sortBy(field: string, direction?: SortDirection): this;
}

Type Parameters

  • DocumentType

Methods

[asyncIterator] all count distinct explain first firstOrFail limit skip sort sortBy

Methods

[asyncIterator]

all

count

  • count(): Promise<number>

  • Counts all matching documents. Calling this method after skip or limit might not count everything.

    Returns Promise<number>

distinct

  • distinct<T = unknown>(key: string): Promise<T[]>

  • Performs a distinct query.

    Type Parameters

    • T = unknown

    Parameters

    • key: string

    Returns Promise<T[]>

explain

  • explain(verbosity?: ExplainVerbosityLike): Promise<Document>

  • Performs an explain query.

    Parameters

    • Optionalverbosity: ExplainVerbosityLike

    Returns Promise<Document>

first

firstOrFail

limit

  • limit(number: number): this

  • Limit the result to number entries. Cancels any previous limit call.

    Parameters

    • number: number

    Returns this

skip

  • skip(number: number): this

  • Skip number entries. Cancels any previous skip call.

    Parameters

    • number: number

    Returns this

sort

sortBy

  • sortBy(field: string, direction?: SortDirection): this

  • Add a new criterion to the sort.

    Parameters

    • field: string
    • Optionaldirection: SortDirection

    Returns this

Settings

Member Visibility

On This Page

Methods