AggregationCursor | mongodb (original) (raw)

[asyncIterator]

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

• Returns AsyncGenerator<TSchema, void, void>

Optional[captureRejectionSymbol]

• [captureRejectionSymbol]<K>(error, event, ...args): void

• Type Parameters

  • K

Parameters

• error: Error
• event: string | symbol
• Rest...args: AnyRest

Returns void

addCursorFlag

• addCursorFlag(flag, value): this

• Parameters

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

Returns this

addListener

• addListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• addListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• addListener(event, listener): this

• Returns this

addStage

• addStage(stage): this

• Returns this

• addStage<T>(stage): AggregationCursor<T>

• Type Parameters

  • T = Document

Returns AggregationCursor<T>

batchSize

• batchSize(value): this

• Returns this

bufferedCount

• bufferedCount(): number

• Returns number

clone

• clone(): AggregationCursor<TSchema>

• Returns AggregationCursor<TSchema>

close

• close(options?): Promise<void>

• Parameters

  • Optionaloptions: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns Promise<void>

emit

• emit<EventKey>(event, ...args): boolean

• Type Parameters

  • EventKey extends "close"

Returns boolean

eventNames

• eventNames(): string[]

• Returns string[]

explain

• explain(): Promise<Document>

• Returns Promise<Document>

• explain(verbosity): Promise<Document>

• Returns Promise<Document>

• explain(options): Promise<Document>

• Parameters

  • options: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns Promise<Document>

• explain(verbosity, options): Promise<Document>

• Parameters

  • verbosity: ExplainVerbosityLike | ExplainCommandOptions
  • options: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns Promise<Document>

forEach

• forEach(iterator): Promise<void>

• Parameters

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

Returns Promise<void>

geoNear

• geoNear($geoNear): this

• Returns this

getMaxListeners

• getMaxListeners(): number

• Returns number

group

• group<T>($group): AggregationCursor<T>

• Type Parameters

  • T = TSchema

Returns AggregationCursor<T>

hasNext

• hasNext(): Promise<boolean>

• Returns Promise<boolean>

limit

• limit($limit): this

• Returns this

listenerCount

• listenerCount<EventKey>(type): number

• Type Parameters

  • EventKey extends "close"

Parameters

• type: string | symbol | EventKey

Returns number

listeners

• listeners<EventKey>(event): AbstractCursorEvents[EventKey][]

• Type Parameters

  • EventKey extends "close"

Parameters

• event: string | symbol | EventKey

Returns AbstractCursorEvents[EventKey][]

lookup

• lookup($lookup): this

• Returns this

map

• map<T>(transform): AggregationCursor<T>

• Type Parameters

  • T

Parameters

• transform: ((doc: TSchema) => T)
  * * (doc): T
  * #### Returns T

Returns AggregationCursor<T>

match

• match($match): this

• Returns this

maxTimeMS

• maxTimeMS(value): this

• Returns this

next

• next(): Promise<null | TSchema>

• Returns Promise<null | TSchema>

off

• off<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• off(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• off(event, listener): this

• Returns this

on

• on<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• on(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• on(event, listener): this

• Returns this

once

• once<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• once(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• once(event, listener): this

• Returns this

out

• out($out): this

• Parameters

  • $out: string | {
    coll: string;
    db: string;
    }

Returns this

prependListener

• prependListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• prependListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependListener(event, listener): this

• Returns this

prependOnceListener

• prependOnceListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• prependOnceListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• prependOnceListener(event, listener): this

• Returns this

project

• project<T>($project): AggregationCursor<T>

• Type Parameters

  • T extends Document = Document

Returns AggregationCursor<T>

rawListeners

• rawListeners<EventKey>(event): AbstractCursorEvents[EventKey][]

• Type Parameters

  • EventKey extends "close"

Parameters

• event: string | symbol | EventKey

Returns AbstractCursorEvents[EventKey][]

readBufferedDocuments

• readBufferedDocuments(number?): NonNullable<TSchema>[]

• Parameters

  • Optionalnumber: number

Returns NonNullable<TSchema>[]

redact

• redact($redact): this

• Returns this

removeAllListeners

• removeAllListeners<EventKey>(event?): this

• Type Parameters

  • EventKey extends "close"

Parameters

• Optionalevent: string | symbol | EventKey

Returns this

removeListener

• removeListener<EventKey>(event, listener): this

• Type Parameters

  • EventKey extends "close"

Returns this

• removeListener(event, listener): this

• Parameters

  • event: CommonEvents
  • listener: ((eventName: string | symbol, listener: GenericListener) => void)
    * * (eventName, listener): void
    * #### Returns void

Returns this

• removeListener(event, listener): this

• Returns this

ProtectedresolveExplainTimeoutOptions

• resolveExplainTimeoutOptions(verbosity?, options?): {
  explain?: ExplainVerbosityLike | ExplainCommandOptions;
  timeout?: {
  timeoutMS?: number;
  };
  }

• Parameters

  • Optionalverbosity: ExplainVerbosityLike | ExplainCommandOptions | {
    timeoutMS?: number;
    }
  • Optionaloptions: {
    timeoutMS?: number;
    }
    * ##### OptionaltimeoutMS?: number

Returns {

explain?: ExplainVerbosityLike | ExplainCommandOptions;
timeout?: {
timeoutMS?: number;
};
}

• Optionalexplain?: ExplainVerbosityLike | ExplainCommandOptions

• Optionaltimeout?: {

timeoutMS?: number;
}
* ##### OptionaltimeoutMS?: number

rewind

• rewind(): void

• Returns void

setMaxListeners

• setMaxListeners(n): this

• Returns this

skip

• skip($skip): this

• Returns this

sort

• sort($sort): this

• Returns this

stream

• stream(options?): Readable & AsyncIterable<TSchema>

• Returns Readable & AsyncIterable<TSchema>

toArray

• toArray(): Promise<TSchema[]>

• Returns Promise<TSchema[]>

tryNext

• tryNext(): Promise<null | TSchema>

• Returns Promise<null | TSchema>

unwind

• unwind($unwind): this

• Returns this

withReadConcern

• withReadConcern(readConcern): this

• Returns this

withReadPreference

• withReadPreference(readPreference): this

• Returns this

StaticaddAbortListener

• addAbortListener(signal, resource): Disposable
• Experimental

Parameters

• signal: AbortSignal
• resource: ((event: Event) => void)
  * * (event): void
  * #### Returns void

Returns Disposable

Disposable that removes the abort listener.

StaticgetEventListeners

• getEventListeners(emitter, name): Function[]

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget
  • name: string | symbol

Returns Function[]

StaticgetMaxListeners

• getMaxListeners(emitter): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap> | EventTarget

Returns number

StaticlistenerCount

• listenerCount(emitter, eventName): number

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol

Returns number

Staticon

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

An AsyncIterator that iterates eventName events emitted by the emitter

• on(emitter, eventName, options?): AsyncIterator<any[], any, any>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterIteratorOptions

Returns AsyncIterator<any[], any, any>

Staticonce

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventEmitter<DefaultEventMap>
  • eventName: string | symbol
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

• once(emitter, eventName, options?): Promise<any[]>

• Parameters

  • emitter: EventTarget
  • eventName: string
  • Optionaloptions: StaticEventEmitterOptions

Returns Promise<any[]>

StaticsetMaxListeners

• setMaxListeners(n?, ...eventTargets): void

• Parameters

  • Optionaln: number
  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

Returns void