Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractCursor<TSchema, CursorEvents>

Type parameters

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Properties

[kClosed]

[kClosed]: boolean
internal

[kDocuments]

[kDocuments]: TSchema[]
internal

Optional [kId]

[kId]: Long
internal

[kInitialized]

[kInitialized]: boolean
internal

[kKilled]

[kKilled]: boolean
internal

[kNamespace]

[kNamespace]: MongoDBNamespace
internal

[kOptions]

[kOptions]: InternalAbstractCursorOptions
internal

Optional [kServer]

[kServer]: Server
internal

Optional [kSession]

[kSession]: ClientSession
internal

[kTopology]

[kTopology]: Topology
internal

Optional [kTransform]

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

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

namespace

readConcern

readPreference

server

  • get server(): undefined | Server

session

topology

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<null | TSchema, any, undefined>

_getMore

Abstract _initialize

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): AbstractCursor<TSchema, CursorEvents>

  • 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 AbstractCursor<TSchema, CursorEvents>

addListener

batchSize

bufferedCount

  • bufferedCount(): number

Abstract clone

close

emit

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

  • Type parameters

    • EventKey: string | number | symbol

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<CursorEvents[EventKey]>

    Returns boolean

eventNames

  • eventNames(): string[]

forEach

  • forEach<T>(iterator: (doc: T) => boolean | void): Promise<void>
  • forEach<T>(iterator: (doc: T) => boolean | void, callback: Callback<void>): void

  • Iterates over all the documents for this cursor using the iterator, callback pattern.

    Type parameters

    • T = TSchema

    Parameters

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

      The iteration callback.

        • (doc: T): boolean | void

        • Parameters

          • doc: T

          Returns boolean | void

    Returns Promise<void>

  • Type parameters

    • T = TSchema

    Parameters

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

        • Parameters

          • doc: T

          Returns boolean | void

    • callback: Callback<void>

    Returns void

getMaxListeners

  • getMaxListeners(): number

hasNext

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

listenerCount

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

listeners

  • listeners<EventKey>(event: string | symbol | EventKey): CursorEvents[EventKey][]

map

  • 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: 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. Take note of the following example:

    example
    const cursor: FindCursor<Document> = coll.find();
const mappedCursor: FindCursor<number> = cursor.map(doc => Object.keys(doc).length);
const keyCounts: number[] = await mappedCursor.toArray(); // cursor.toArray() still returns Document[]

    Type parameters

    • T = any

    Parameters

    • transform: (doc: TSchema) => T

      The mapping transformation method.

        • (doc: TSchema): T

        • Parameters

          • doc: TSchema

          Returns T

    Returns AbstractCursor<T, AbstractCursorEvents>

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 AbstractCursor<TSchema, CursorEvents>

next

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

off

on

once

prependListener

prependOnceListener

rawListeners

  • rawListeners<EventKey>(event: string | symbol | EventKey): CursorEvents[EventKey][]

readBufferedDocuments

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

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): AbstractCursor<TSchema, CursorEvents>

removeListener

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

stream

toArray

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

  • Returns an array of documents. The caller is responsible for making sure that there is enough memory to store the results. Note that the array only contains partial results when this cursor had been previously accessed. In that case, cursor.rewind() can be used to reset the cursor.

    Type parameters

    • T = TSchema

    Returns Promise<T[]>

  • Type parameters

    • T = TSchema

    Parameters

    Returns void

tryNext

  • tryNext<T>(): Promise<null | T>
  • tryNext<T>(callback: Callback<null | T>): 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