Class BasePendingCursorOperationAbstract

Hierarchy

Implements

Properties

The collection the receiver is operating on.

query: string

The query the receiver is operating with.

queryArgs: QueryArguments

The named arguments for the query.

Methods

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

    Returns

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

    Returns Promise<DocumentID[]>

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

    Returns

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

    Returns Promise<Document[]>

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

    Returns

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

    Parameters

    • limit: number

      The maximum number of documents that will be returned.

    Returns 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.

    Returns

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

    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

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

    Returns

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

    Returns Promise<DocumentID[]>

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

    Returns

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

    Parameters

    • propertyPath: string
    • Optional direction: SortDirection

      Specify whether you want the sorting order to be Ascending or Descending.

    Returns BasePendingCursorOperation