Interface QueryContract<DocumentType>

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

Type Parameters

  • DocumentType

Methods

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

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<DocumentType>

  • Returns an iterator on all matching documents.

    Returns AsyncIterableIterator<DocumentType>

all

  • all(): Promise<DocumentType[]>

  • Returns all matching documents.

    Returns Promise<DocumentType[]>

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>(key): Promise<T[]>

  • Performs a distinct query.

    Type Parameters

    • T = unknown

    Parameters

    • key: string

    Returns Promise<T[]>

explain

  • explain(verbosity?): Promise<Document>

  • Performs an explain query.

    Parameters

    • Optional verbosity: ExplainVerbosityLike

    Returns Promise<Document>

first

  • first(): Promise<null | DocumentType>

  • Returns the first matching document or null.

    Returns Promise<null | DocumentType>

firstOrFail

  • firstOrFail(): Promise<DocumentType>

  • Returns the first matching document or throws.

    Returns Promise<DocumentType>

limit

skip

sort

sortBy

Settings

Member Visibility

Theme

On This Page