Server | mongodb

internal

Hierarchy层级

TypedEventEmitter<ServerEvents>
- Server

Index索引

Constructors构造函数

constructor

Events事件

Properties属性

Accessors访问器

Methods方法

Constructors构造函数

constructor

new Server(topology: Topology, description: ServerDescription, options: ServerOptions): Server

Overrides TypedEventEmitter.constructor
- ~~Defined in~~ 定义位置：src/sdam/server.ts:133
Create a server

~~Parameters~~参数
- topology: Topology
- description: ServerDescription
- options: ServerOptions
~~Returns~~返回Server

Events事件

Static Readonly CLOSED

CLOSED: "closed" = ...

Static Readonly CONNECT

CONNECT: "connect" = ...

Static Readonly DESCRIPTION_RECEIVED

DESCRIPTION_RECEIVED: "descriptionReceived" = ...

Static Readonly ENDED

ENDED: "ended" = ...

Static Readonly SERVER_HEARTBEAT_FAILED

SERVER_HEARTBEAT_FAILED: "serverHeartbeatFailed" = ...

Static Readonly SERVER_HEARTBEAT_STARTED

SERVER_HEARTBEAT_STARTED: "serverHeartbeatStarted" = ...

Static Readonly SERVER_HEARTBEAT_SUCCEEDED

SERVER_HEARTBEAT_SUCCEEDED: "serverHeartbeatSucceeded" = ...

Properties属性

[kMonitor]

[kMonitor]: Monitor

Optional clusterTime

clusterTime: ClusterTime

Optional ismaster

ismaster: Document

s

s: ServerPrivate

internal

Optional serverApi

serverApi: ServerApi

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访问器

autoEncrypter

get autoEncrypter(): undefined | AutoEncrypter

- ~~Defined in~~ 定义位置：src/sdam/server.ts:195
~~Returns~~返回undefined | AutoEncrypter

description

get description(): ServerDescription

- ~~Defined in~~ 定义位置：src/sdam/server.ts:187
~~Returns~~返回ServerDescription

loadBalanced

get loadBalanced(): boolean

- ~~Defined in~~ 定义位置：src/sdam/server.ts:201
~~Returns~~返回boolean

name

get name(): string

- ~~Defined in~~ 定义位置：src/sdam/server.ts:191
~~Returns~~返回string

Methods方法

addListener

addListener<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
addListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
addListener(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:341
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:342
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:346
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

command

command(ns: MongoDBNamespace, cmd: Document, callback: Callback<any>): void
command(ns: MongoDBNamespace, cmd: Document, options: CommandOptions, callback: Callback<Document>): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:268
Execute a command

internal

~~Parameters~~参数
- ns: MongoDBNamespace
- cmd: Document
- callback: Callback<any>
~~Returns~~返回void
- ~~Defined in~~ 定义位置：src/sdam/server.ts:270
internal

~~Parameters~~参数
- ns: MongoDBNamespace
- cmd: Document
- options: CommandOptions
- callback: Callback<Document>
~~Returns~~返回void

connect

connect(): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:208
Initiate server connect

~~Returns~~返回void

destroy

destroy(options?: DestroyOptions, callback?: Callback<any>): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:227
Destroy the server connection

~~Parameters~~参数
- Optional options: DestroyOptions
- Optional callback: Callback<any>
~~Returns~~返回void

emit

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

~~Inherited from~~继承自 TypedEventEmitter.emit
- ~~Defined in~~ 定义位置：src/mongo_types.ts:388
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: symbol | EventKey
- Rest ...args: Parameters<ServerEvents[EventKey]>
~~Returns~~返回boolean

eventNames

eventNames(): string[]

~~Inherited from~~继承自 TypedEventEmitter.eventNames
- ~~Defined in~~ 定义位置：src/mongo_types.ts:414
~~Returns~~返回string[]

getMaxListeners

getMaxListeners(): number

~~Inherited from~~继承自 TypedEventEmitter.getMaxListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:415
~~Returns~~返回number

getMore

getMore(ns: MongoDBNamespace, cursorId: Long, options: GetMoreOptions, callback: Callback<Document>): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:380
Execute a getMore against the server

internal

~~Parameters~~参数
- ns: MongoDBNamespace
- cursorId: Long
- options: GetMoreOptions
- callback: Callback<Document>
~~Returns~~返回void

killCursors

killCursors(ns: MongoDBNamespace, cursorIds: Long[], options: CommandOptions, callback?: Callback<any>): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:414
Execute a killCursors command against the server

internal

~~Parameters~~参数
- ns: MongoDBNamespace
- cursorIds: Long[]
- options: CommandOptions
- Optional callback: Callback<any>
~~Returns~~返回void

listenerCount

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

~~Inherited from~~继承自 TypedEventEmitter.listenerCount
- ~~Defined in~~ 定义位置：src/mongo_types.ts:393
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- type: string | symbol | EventKey
~~Returns~~返回number

listeners

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

~~Inherited from~~继承自 TypedEventEmitter.listeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:380
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: string | symbol | EventKey
~~Returns~~返回ServerEvents[EventKey][]

off

off<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
off(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
off(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:369
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:370
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:374
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

on

on<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
on(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
on(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:348
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:349
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:353
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

once

once<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
once(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
once(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:355
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:356
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:360
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

prependListener

prependListener<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
prependListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
prependListener(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:397
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:398
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:402
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
prependOnceListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
prependOnceListener(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:404
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:408
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:412
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

query

query(ns: MongoDBNamespace, cmd: Document, options: QueryOptions, callback: Callback<any>): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:351
Execute a query against the server

internal

~~Parameters~~参数
- ns: MongoDBNamespace
- cmd: Document
- options: QueryOptions
- callback: Callback<any>
~~Returns~~返回void

rawListeners

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

~~Inherited from~~继承自 TypedEventEmitter.rawListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:384
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: string | symbol | EventKey
~~Returns~~返回ServerEvents[EventKey][]

removeAllListeners

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

~~Inherited from~~继承自 TypedEventEmitter.removeAllListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:376
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- Optional event: string | symbol | EventKey
~~Returns~~返回Server

removeListener

removeListener<EventKey>(event: EventKey, listener: ServerEvents[EventKey]): Server
removeListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Server
removeListener(event: string | symbol, listener: GenericListener): Server

~~Inherited from~~继承自 TypedEventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:362
~~Type parameters~~类型参数
- EventKey: "commandStarted" | "commandSucceeded" | "commandFailed" | "clusterTimeReceived" | "pinned" | "unpinned" | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged"
~~Parameters~~参数
- event: EventKey
- listener: ServerEvents[EventKey]
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:363
~~Parameters~~参数
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - ~~Parameters~~参数
      - eventName: string | symbol
      - listener: GenericListener
      ~~Returns~~返回void
~~Returns~~返回Server
~~Inherited from~~继承自 TypedEventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:367
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Server

requestCheck

requestCheck(): void

- ~~Defined in~~ 定义位置：src/sdam/server.ts:258
Immediately schedule monitoring of this server. If there already an attempt being made this will be a no-op.

~~Returns~~返回void

setMaxListeners

setMaxListeners(n: number): Server

~~Inherited from~~继承自 TypedEventEmitter.setMaxListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:416
~~Parameters~~参数
- n: number
~~Returns~~返回Server

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

~~Inherited from~~继承自 TypedEventEmitter.getEventListener
- ~~Defined in~~ 定义位置：node_modules/@types/node/events.d.ts:34
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

~~Inherited from~~继承自 TypedEventEmitter.listenerCount
- ~~Defined in~~ 定义位置：node_modules/@types/node/events.d.ts:30
deprecated

since v4.0.0

~~Parameters~~参数
- emitter: EventEmitter
- event: string | symbol
~~Returns~~返回number

Static on

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

~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：node_modules/@types/node/events.d.ts:27
~~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[]>

~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：node_modules/@types/node/events.d.ts:25
~~Parameters~~参数
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
~~Returns~~返回Promise<any[]>
~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：node_modules/@types/node/events.d.ts:26
~~Parameters~~参数
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
~~Returns~~返回Promise<any[]>

Hierarchy层级

Index索引

Constructors构造函数

Events事件

Properties属性

Accessors访问器

Methods方法

Constructors构造函数

constructor

Parameters参数

topology: Topology

description: ServerDescription

options: ServerOptions

Returns返回Server

Events事件

Static Readonly CLOSED

Static Readonly CONNECT

Static Readonly DESCRIPTION_RECEIVED

Static Readonly ENDED

Static Readonly SERVER_HEARTBEAT_FAILED

Static Readonly SERVER_HEARTBEAT_STARTED

Static Readonly SERVER_HEARTBEAT_SUCCEEDED

Properties属性

[kMonitor]

Optional clusterTime

Optional ismaster

s

Optional serverApi

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors访问器

autoEncrypter

Returns返回undefined | AutoEncrypter

description

Returns返回ServerDescription

loadBalanced

Returns返回boolean

name

Returns返回string

Methods方法

addListener

Type parameters类型参数

Parameters参数

event: EventKey

listener: ServerEvents[EventKey]

Returns返回Server

Parameters参数

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters参数

eventName: string | symbol

listener: GenericListener

Returns返回void

Returns返回Server

Parameters参数

event: string | symbol

listener: GenericListener

Returns返回Server

command

Parameters参数

ns: MongoDBNamespace

cmd: Document

callback: Callback<any>

Returns返回void

Parameters参数

ns: MongoDBNamespace

cmd: Document

options: CommandOptions

callback: Callback<Document>

Returns返回void

connect

Returns返回void

destroy

Parameters参数

Optional options: DestroyOptions

Optional callback: Callback<any>

Returns返回void

emit