Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FindCursor<TSchema>

Type parameters

Hierarchy

Index

Constructors

constructor

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Properties

[kBuiltOptions]

[kBuiltOptions]: FindOptions<Document>
internal

[kClosed]

[kClosed]: boolean
internal

[kDocuments]

[kDocuments]: TSchema[]
internal

[kFilter]

[kFilter]: Document
internal

Optional [kId]

[kId]: Long
internal

[kInitialized]

[kInitialized]: boolean
internal

[kKilled]

[kKilled]: boolean
internal

[kNamespace]

[kNamespace]: MongoDBNamespace
internal

Optional [kNumReturned]

[kNumReturned]: number
internal

[kOptions]

internal

Optional [kServer]

[kServer]: Server
internal

Optional [kSession]

[kSession]: ClientSession
internal

[kTopology]

[kTopology]: Topology
internal

Optional [kTransform]

[kTransform]: (doc: TSchema) => Document
internal

Type declaration

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

closed

  • get closed(): boolean

cursorOptions

id

  • get id(): undefined | Long

killed

  • get killed(): boolean

loadBalanced

  • get loadBalanced(): boolean

namespace

readConcern

readPreference

server

  • get server(): undefined | Server

session

topology

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<TSchema, void, undefined>

_getMore

_initialize

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): FindCursor<TSchema>
  • Add a cursor flag to the cursor

    Parameters

    • flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial"

      The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.

    • value: boolean

      The flag boolean value.

    Returns FindCursor<TSchema>

addListener

addQueryModifier

  • addQueryModifier(name: string, value: string | number | boolean | Document): FindCursor<TSchema>
  • Add a query modifier to the cursor query

    Parameters

    • name: string

      The query modifier (must start with $, such as $orderby etc)

    • value: string | number | boolean | Document

      The modifier value.

    Returns FindCursor<TSchema>

allowDiskUse

batchSize

bufferedCount

  • bufferedCount(): number

clone

close

collation

  • Set the collation options for the cursor.

    Parameters

    • value: CollationOptions

      The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).

    Returns FindCursor<TSchema>

comment

  • Add a comment to the cursor query allowing for tracking the comment in the log.

    Parameters

    • value: string

      The comment attached to this query.

    Returns FindCursor<TSchema>

count

emit

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<AbstractCursorEvents[EventKey]>): boolean

eventNames

  • eventNames(): string[]

explain

filter

forEach

  • forEach(iterator: (doc: TSchema) => boolean | void): Promise<void>
  • forEach(iterator: (doc: TSchema) => boolean | void, callback: Callback<void>): void
  • Iterates over all the documents for this cursor using the iterator, callback pattern.

    Parameters

    • iterator: (doc: TSchema) => boolean | void

      The iteration callback.

        • (doc: TSchema): boolean | void
        • Parameters

          • doc: TSchema

          Returns boolean | void

    Returns Promise<void>

  • Parameters

    • iterator: (doc: TSchema) => boolean | void
        • (doc: TSchema): boolean | void
        • Parameters

          • doc: TSchema

          Returns boolean | void

    • callback: Callback<void>

    Returns void

getMaxListeners

  • getMaxListeners(): number

hasNext

  • hasNext(): Promise<boolean>
  • hasNext(callback: Callback<boolean>): void

hint

limit

listenerCount

  • listenerCount<EventKey>(type: string | symbol | EventKey): number

listeners

map

  • map<T>(transform: (doc: TSchema) => T): FindCursor<T>
  • Map all documents using the provided function If there is a transform set on the cursor, that will be called first and the result passed to this function's transform.

    remarks

    Note for Typescript Users: adding a transform changes the return type of the iteration of this cursor, it does not return a new instance of a cursor. This means when calling map, you should always assign the result to a new variable in order to get a correctly typed cursor variable. Take note of the following example:

    Type parameters

    • T

    Parameters

    • transform: (doc: TSchema) => T
        • (doc: TSchema): T
        • Parameters

          • doc: TSchema

          Returns T

    Returns FindCursor<T>

max

  • Set the cursor max

    Parameters

    • max: Document

      Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). The $max specifies the upper bound for all keys of a specific index in order.

    Returns FindCursor<TSchema>

maxAwaitTimeMS

  • maxAwaitTimeMS(value: number): FindCursor<TSchema>
  • Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)

    Parameters

    • value: number

      Number of milliseconds to wait before aborting the tailed query.

    Returns FindCursor<TSchema>

maxTimeMS

  • Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)

    Parameters

    • value: number

      Number of milliseconds to wait before aborting the query.

    Returns FindCursor<TSchema>

min

  • Set the cursor min

    Parameters

    • min: Document

      Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.

    Returns FindCursor<TSchema>

next

  • next(): Promise<null | TSchema>
  • next(callback: Callback<null | TSchema>): void
  • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

off

on

once

prependListener

prependOnceListener

project

  • Add a project stage to the aggregation pipeline

    remarks

    In order to strictly type this function you must provide an interface that represents the effect of your projection on the result documents.

    By default chaining a projection to your cursor changes the returned type to the generic Document type. You should specify a parameterized type to have assertions on your final results.

    example
    // Best way
    const docs: FindCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
    // Flexible way
    const docs: FindCursor<Document> = cursor.project({ _id: 0, a: true });
    
    remarks

    Note for Typescript Users: adding a transform changes the return type of the iteration of this cursor, it does not return a new instance of a cursor. This means when calling project, you should always assign the result to a new variable in order to get a correctly typed cursor variable. Take note of the following example:

    example
    const cursor: FindCursor<{ a: number; b: string }> = coll.find();
    const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
    const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
    
    // or always use chaining and save the final cursor
    
    const cursor = coll.find().project<{ a: string }>({
      _id: 0,
      a: { $convert: { input: '$a', to: 'string' }
    }});
    

    Type parameters

    Parameters

    Returns FindCursor<T>

rawListeners

readBufferedDocuments

  • readBufferedDocuments(number?: number): TSchema[]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): FindCursor<TSchema>

removeListener

returnKey

  • Set the cursor returnKey. If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents. If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.

    Parameters

    • value: boolean

      the returnKey value.

    Returns FindCursor<TSchema>

rewind

  • rewind(): void
  • Rewind this cursor to its uninitialized state. Any options that are present on the cursor will remain in effect. Iterating this cursor will cause new queries to be sent to the server, even if the resultant data has already been retrieved by this cursor.

    Returns void

setMaxListeners

showRecordId

  • showRecordId(value: boolean): FindCursor<TSchema>
  • Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.

    Parameters

    • value: boolean

      The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.

    Returns FindCursor<TSchema>

skip

sort

stream

toArray

  • toArray(): Promise<TSchema[]>
  • toArray(callback: Callback<TSchema[]>): void

tryNext

  • tryNext(): Promise<null | TSchema>
  • tryNext(callback: Callback<null | TSchema>): void

withReadConcern

withReadPreference

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc