Class BasePendingCursorOperationAbstract

Readonly collection

Readonly query

Readonly queryArgs

Abstract evict

• evict(): Promise<DocumentID[]>

• Evicts all documents that match the query generated by the preceding function chaining.

  Returns Promise<DocumentID[]>

  An array promise containing the IDs of the documents that were evicted.

exec

• exec(): Promise<Document[]>

• Executes the query generated by the preceding function chaining and return the list of matching documents.

  Returns Promise<Document[]>

  An array promise containing documents matching the query generated by the preceding function chaining.

limit

• limit(limit): BasePendingCursorOperation

• Limits the number of documents that get returned when querying a collection for matching documents.

  Parameters

  • limit: number

    The maximum number of documents that will be returned.

  Returns BasePendingCursorOperation

  A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.

offset

• offset(offset): BasePendingCursorOperation

• Offsets the resulting set of matching documents.

  This is useful if you aren't interested in the first N matching documents for one reason or another. For example, you might already have queried the collection and obtained the first 20 matching documents and so you might want to run the same query as you did previously but ignore the first 20 matching documents, and that is when you would use offset.

  Parameters

  • offset: number

    The number of matching documents that you want the eventual resulting set of matching documents to be offset by (and thus not include).

  Returns BasePendingCursorOperation

  A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.

Abstract remove

• remove(): Promise<DocumentID[]>

• Removes all documents that match the query generated by the preceding function chaining.

  Returns Promise<DocumentID[]>

  An array promise containing the IDs of the documents that were removed.

sort

• sort(query, direction?): BasePendingCursorOperation

• Sorts the documents that match the query provided in the preceding find-like function call.

  Documents that are missing the field to sort by will appear at the beginning of the results when sorting in ascending order.

  Parameters

  • query: string

    Name or path of the field to sort by.
  • Optional direction: SortDirection

    Specify whether you want the sorting order to be ascending or descending. Defaults to ascending.

  Returns BasePendingCursorOperation

  A cursor that you can chain further function calls and then either get the matching documents immediately or get updates about them over time.

Abstract update

• update(closure): Promise<UpdateResultsMap>

• Updates documents that match the query generated by the preceding function chaining.

  Document values must not be set to any non-finite numbers (NaN, Infinity, -Infinity).

  Parameters

  • closure: ((documents) => void)

    A closure that gets called with all of the documents matching the query. The documents are instances of MutableDocument so you can call update-related functions on them.

    • • (documents): void

      • Parameters

        • documents: MutableDocument[]

        Returns void

  Returns Promise<UpdateResultsMap>

  An UpdateResultsMap promise mapping document IDs to lists of update results that describe the updates that were performed for each document.