Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractCursor<TSchema, CursorEvents>

Type parameters

Hierarchy

Index

Constructors

constructor

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Properties

[kClosed]

[kClosed]: boolean

[kDocuments]

[kDocuments]: TSchema[]

Optional [kId]

[kId]?: Long

[kInitialized]

[kInitialized]: boolean

[kKilled]

[kKilled]: boolean

[kNamespace]

[kNamespace]: MongoDBNamespace

[kOptions]

Optional [kServer]

[kServer]?: Server

Optional [kSession]

[kSession]?: ClientSession

[kTopology]

[kTopology]: Topology

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

loadBalanced

  • get loadBalanced(): boolean

namespace

readConcern

readPreference

server

  • get server(): undefined | Server

session

topology

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<TSchema, void, 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(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

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 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:

    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(): Promise<null | TSchema>
  • next(callback: Callback<null | TSchema>): void
  • next(callback?: Callback<null | TSchema>): void | Promise<null | TSchema>

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(): Promise<TSchema[]>
  • toArray(callback: Callback<TSchema[]>): 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.

    Returns Promise<TSchema[]>

  • Parameters

    Returns void

tryNext

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

withReadConcern

withReadPreference

Static getEventListeners

  • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

    const { getEventListeners, EventEmitter } = require('events');

    {
    const ee = new EventEmitter();
    const listener = () => console.log('Events are fun');
    ee.on('foo', listener);
    getEventListeners(ee, 'foo'); // [listener]
    }
    {
    const et = new EventTarget();
    const listener = () => console.log('Events are fun');
    et.addEventListener('foo', listener);
    getEventListeners(et, 'foo'); // [listener]
    }
    since

    v15.2.0

    Parameters

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

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
    since

    v0.9.12

    deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

Static on

  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • ```js const { on, EventEmitter } = require('events');

    (async () => { const ee = new EventEmitter();

    // Emit later on process.nextTick(() => { ee.emit('foo', 'bar'); ee.emit('foo', 42); });

    for await (const event of on(ee, 'foo')) { // The execution of this inner block is synchronous and it // processes one event at a time (even with await). Do not use // if concurrent execution is required. console.log(event); // prints ['bar'] [42] } // Unreachable here })();


    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    process.nextTick(() => ac.abort());
    since

    v13.6.0, v12.16.0

    Parameters

    • emitter: EventEmitter
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

Static once

  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

    const { once, EventEmitter } = require('events');

    async function run() {
    const ee = new EventEmitter();

    process.nextTick(() => {
    ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
    ee.emit('error', err);
    });

    try {
    await once(ee, 'myevent');
    } catch (err) {
    console.log('error happened', err);
    }
    }

    run();

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
    .then(([err]) => console.log('ok', err.message))
    .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom

    An AbortSignal can be used to cancel waiting for the event:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
    try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
    } catch (error) {
    if (error.name === 'AbortError') {
    console.error('Waiting for the event was canceled!');
    } else {
    console.error('There was an error', error.message);
    }
    }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
    since

    v11.13.0, v10.16.0

    Parameters

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

    Returns Promise<any[]>

  • Parameters

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

    Returns Promise<any[]>

Generated using TypeDoc