Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListIndexesCursor

Hierarchy层级

Index索引

Constructors构造函数

Events事件

Properties属性

Accessors访问器

Methods方法

Constructors构造函数

constructor

Events事件

Static Readonly CLOSE

CLOSE: "close" = ...

Properties属性

[kClosed]

[kClosed]: boolean
internal

[kDocuments]

[kDocuments]: any[]
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: any) => Document
internal

Type declaration类型声明

Optional options

options: ListIndexesOptions

parent

parent: Collection<Document>

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<any, void, undefined>

_getMore

_initialize

addCursorFlag

  • addCursorFlag(flag: "tailable" | "awaitData" | "noCursorTimeout" | "oplogReplay" | "exhaust" | "partial", value: boolean): ListIndexesCursor

  • 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返回ListIndexesCursor

addListener

batchSize

bufferedCount

  • bufferedCount(): number

clone

close

emit

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

eventNames

  • eventNames(): string[]

forEach

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

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

    Parameters参数

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

      The iteration callback.

        • (doc: any): boolean | void

        • Parameters参数

          • doc: any

          Returns返回boolean | void

    Returns返回Promise<void>

  • Parameters参数

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

        • Parameters参数

          • doc: any

          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

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: any) => T

      The mapping transformation method.

        • (doc: any): T

        • Parameters参数

          • doc: any

          Returns返回T

    Returns返回AbstractCursor<T, AbstractCursorEvents>

maxTimeMS

next

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

off

on

once

prependListener

prependOnceListener

rawListeners

readBufferedDocuments

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

removeAllListeners

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

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

  • Parameters参数

    Returns返回void

tryNext

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