Class Cursor<T>

Cursor to iterate and perform filtering on matched objects. This object must not be used directly. A cursor may be obtaine from calling find() on an instance of Query.

Param: collection

The input source of the collection

Param: predicate

A predicate function to test documents

Param: projection

A projection criteria

Param: options

Options

Type Parameters

  • T

Constructors

constructor

Methods

[iterator] all collation count forEach hasNext limit map next skip sort

Constructors

constructor

Methods

[iterator]

all

  • all(): T[]

    Return remaining objects in the cursor as an array. This method exhausts the cursor

    Returns T[]

collation

count

  • count(): number

    Returns the number of objects return in the cursor. This method exhausts the cursor

    Returns number

forEach

hasNext

  • hasNext(): boolean

    Returns true if the cursor has documents and can be iterated.

    Returns boolean

limit

  • limit(n: number): Cursor<T>

    Constrains the size of a cursor's result set.

    Parameters

    • n: number

      the number of results to limit to.

    Returns Cursor<T>

    Returns the cursor, so you can chain this call.

map

  • map<R>(fn: Callback<R, T>): R[]

    Applies a function to each document in a cursor and collects the return values in an array.

    Type Parameters

    • R

    Parameters

    Returns R[]

next

skip

  • skip(n: number): Cursor<T>

    Returns a cursor that begins returning results only after passing or skipping a number of documents.

    Parameters

    • n: number

      the number of results to skip.

    Returns Cursor<T>

    Returns the cursor, so you can chain this call.

sort

  • sort(modifier: AnyObject): Cursor<T>

    Returns results ordered according to a sort specification.

    Parameters

    • modifier: AnyObject

      an object of key and values specifying the sort order. 1 for ascending and -1 for descending

    Returns Cursor<T>

    Returns the cursor, so you can chain this call.

Settings

Member Visibility

On This Page

Constructors
Methods