Topology | mongodb

A container of server instances representing a connection to a MongoDB topology.

internal

Hierarchy层级

TypedEventEmitter<TopologyEvents>
- Topology

Index索引

Constructors构造函数

constructor

Events事件

Properties属性

Accessors访问器

Constructors构造函数

constructor

new Topology(seeds: string | string[] | HostAddress | HostAddress[], options: TopologyOptions): Topology

Overrides TypedEventEmitter.constructor
- ~~Defined in~~ 定义位置：src/sdam/topology.ts:243
~~Parameters~~参数
- seeds: string | string[] | HostAddress | HostAddress[]
- options: TopologyOptions
~~Returns~~返回Topology

Events事件

Static Readonly CLOSE

CLOSE: "close" = ...

Static Readonly CONNECT

CONNECT: "connect" = ...

Static Readonly ERROR

ERROR: "error" = ...

Static Readonly OPEN

OPEN: "open" = ...

Static Readonly SERVER_CLOSED

SERVER_CLOSED: "serverClosed" = ...

Static Readonly SERVER_DESCRIPTION_CHANGED

SERVER_DESCRIPTION_CHANGED: "serverDescriptionChanged" = ...

Static Readonly SERVER_OPENING

SERVER_OPENING: "serverOpening" = ...

Static Readonly TIMEOUT

TIMEOUT: "timeout" = ...

Static Readonly TOPOLOGY_CLOSED

TOPOLOGY_CLOSED: "topologyClosed" = ...

Static Readonly TOPOLOGY_DESCRIPTION_CHANGED

TOPOLOGY_DESCRIPTION_CHANGED: "topologyDescriptionChanged" = ...

Static Readonly TOPOLOGY_OPENING

TOPOLOGY_OPENING: "topologyOpening" = ...

Properties属性

[kWaitQueue]

[kWaitQueue]: Denque<ServerSelectionRequest>

internal

Optional _type

_type: string

internal

bson

bson: { deserialize: (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions) => Document; serialize: (object: Document, options?: SerializeOptions) => Buffer }

internal
privateremarks: mongodb-client-encryption's class ClientEncryption falls back to finding the bson lib defined on client.topology.bson, in order to maintain compatibility with any version of mongodb-client-encryption we keep a reference to serialize and deserialize here.

Type declaration类型声明

deserialize: (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions) => Document
- - (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions): Document
  - Deserialize data as BSON.
    
    ~~Parameters~~参数
    - buffer: Buffer | ArrayBufferView | ArrayBuffer
      
      the buffer containing the serialized set of BSON documents.
    - Optional options: DeserializeOptions
    ~~Returns~~返回Document
    
    returns the deserialized Javascript Object.
serialize: (object: Document, options?: SerializeOptions) => Buffer
- - (object: Document, options?: SerializeOptions): Buffer
  - Serialize a Javascript object.
    
    ~~Parameters~~参数
    - object: Document
      
      the Javascript object to serialize.
    - Optional options: SerializeOptions
    ~~Returns~~返回Buffer
    
    Buffer object containing the serialized object.

Optional ismaster

ismaster: Document

internal

s

s: TopologyPrivate

internal

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

capabilities

get capabilities(): ServerCapabilities

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:395
~~Returns~~返回ServerCapabilities

clientMetadata

get clientMetadata(): ClientMetadata

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:767
~~Returns~~返回ClientMetadata

clusterTime

get clusterTime(): undefined | ClusterTime
set clusterTime(clusterTime: undefined | ClusterTime): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:804
~~Returns~~返回undefined | ClusterTime
- ~~Defined in~~ 定义位置：src/sdam/topology.ts:808
~~Parameters~~参数
- clusterTime: undefined | ClusterTime
~~Returns~~返回void

description

get description(): TopologyDescription

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:387
~~Returns~~返回TopologyDescription

A TopologyDescription for this topology

loadBalanced

get loadBalanced(): boolean

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

logicalSessionTimeoutMinutes

get logicalSessionTimeoutMinutes(): undefined | number

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:800
~~Returns~~返回undefined | number

Methods方法

addListener

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

~~Inherited from~~继承自 TypedEventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:341
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.addListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:346
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

auth

auth(credentials?: MongoCredentials, callback?: Callback<any>): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:762
~~Parameters~~参数
- Optional credentials: MongoCredentials
- Optional callback: Callback<any>
~~Returns~~返回void

close

close(options?: CloseOptions, callback?: Callback<any>): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:479
Close this topology

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

connect

connect(options?: ConnectOptions, callback?: Callback<any>): void

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

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

Private detectShardedTopology

detectShardedTopology(event: TopologyDescriptionChangedEvent): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:349
~~Parameters~~参数
- event: TopologyDescriptionChangedEvent
~~Returns~~返回void

Private detectSrvRecords

detectSrvRecords(ev: SrvPollingEvent): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:364
~~Parameters~~参数
- ev: SrvPollingEvent
~~Returns~~返回void

emit

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

~~Inherited from~~继承自 TypedEventEmitter.emit
- ~~Defined in~~ 定义位置：src/mongo_types.ts:388
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: symbol | EventKey
- Rest ...args: Parameters<TopologyEvents[EventKey]>
~~Returns~~返回boolean

endSessions

endSessions(sessions: ServerSessionId[], callback?: Callback<Document>): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:655
Send endSessions command(s) with the given session ids

~~Parameters~~参数
- sessions: ServerSessionId[]
- Optional callback: Callback<Document>
~~Returns~~返回void

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

hasSessionSupport

hasSessionSupport(): boolean

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

Whether sessions are supported on the current topology

isConnected

isConnected(): boolean

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

isDestroyed

isDestroyed(): boolean

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

lastIsMaster

lastIsMaster(): Document

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:789
~~Returns~~返回Document

listenerCount

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

~~Inherited from~~继承自 TypedEventEmitter.listenerCount
- ~~Defined in~~ 定义位置：src/mongo_types.ts:393
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- type: string | symbol | EventKey
~~Returns~~返回number

listeners

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

~~Inherited from~~继承自 TypedEventEmitter.listeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:380
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: string | symbol | EventKey
~~Returns~~返回TopologyEvents[EventKey][]

off

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

~~Inherited from~~继承自 TypedEventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:369
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.off
- ~~Defined in~~ 定义位置：src/mongo_types.ts:374
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

on

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

~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:348
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.on
- ~~Defined in~~ 定义位置：src/mongo_types.ts:353
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

once

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

~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:355
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.once
- ~~Defined in~~ 定义位置：src/mongo_types.ts:360
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

prependListener

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

~~Inherited from~~继承自 TypedEventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:397
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.prependListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:402
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

prependOnceListener

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

~~Inherited from~~继承自 TypedEventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:404
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.prependOnceListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:412
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

rawListeners

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

~~Inherited from~~继承自 TypedEventEmitter.rawListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:384
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: string | symbol | EventKey
~~Returns~~返回TopologyEvents[EventKey][]

removeAllListeners

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

~~Inherited from~~继承自 TypedEventEmitter.removeAllListeners
- ~~Defined in~~ 定义位置：src/mongo_types.ts:376
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- Optional event: string | symbol | EventKey
~~Returns~~返回Topology

removeListener

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

~~Inherited from~~继承自 TypedEventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:362
~~Type parameters~~类型参数
- EventKey: keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "closed" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"
~~Parameters~~参数
- event: EventKey
- listener: TopologyEvents[EventKey]
~~Returns~~返回Topology
~~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~~返回Topology
~~Inherited from~~继承自 TypedEventEmitter.removeListener
- ~~Defined in~~ 定义位置：src/mongo_types.ts:367
~~Parameters~~参数
- event: string | symbol
- listener: GenericListener
~~Returns~~返回Topology

selectServer

selectServer(options: SelectServerOptions, callback: Callback<Server>): void
selectServer(selector: string | ReadPreference | ServerSelector, callback: Callback<Server>): void
selectServer(selector: string | ReadPreference | ServerSelector, options: SelectServerOptions, callback: Callback<Server>): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:544
Selects a server according to the selection predicate provided

~~Parameters~~参数
- options: SelectServerOptions
  
  Optional settings related to server selection
- callback: Callback<Server>
  
  The callback used to indicate success or failure
~~Returns~~返回void

An instance of a Server meeting the criteria of the predicate provided
- ~~Defined in~~ 定义位置：src/sdam/topology.ts:545
~~Parameters~~参数
- selector: string | ReadPreference | ServerSelector
- callback: Callback<Server>
~~Returns~~返回void
- ~~Defined in~~ 定义位置：src/sdam/topology.ts:549
~~Parameters~~参数
- selector: string | ReadPreference | ServerSelector
- options: SelectServerOptions
- callback: Callback<Server>
~~Returns~~返回void

serverUpdateHandler

serverUpdateHandler(serverDescription: ServerDescription): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:685
Update the internal TopologyDescription with a ServerDescription

~~Parameters~~参数
- serverDescription: ServerDescription
  
  The server to update in the internal list of server descriptions
~~Returns~~返回void

setMaxListeners

setMaxListeners(n: number): Topology

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

shouldCheckForSessionSupport

shouldCheckForSessionSupport(): boolean

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

Whether the topology should initiate selection to determine session support

startSession

startSession(options: ClientSessionOptions, clientOptions?: MongoOptions): ClientSession

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:644
Start a logical session

~~Parameters~~参数
- options: ClientSessionOptions
- Optional clientOptions: MongoOptions
~~Returns~~返回ClientSession

unref

unref(): void

- ~~Defined in~~ 定义位置：src/sdam/topology.ts:782
deprecated

This function is deprecated and will be removed in the next major version.

~~Returns~~返回void

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参数

seeds: string | string[] | HostAddress | HostAddress[]

options: TopologyOptions

Returns返回Topology

Events事件

Static Readonly CLOSE

Static Readonly CONNECT

Static Readonly ERROR

Static Readonly OPEN

Static Readonly SERVER_CLOSED

Static Readonly SERVER_DESCRIPTION_CHANGED

Static Readonly SERVER_OPENING

Static Readonly TIMEOUT

Static Readonly TOPOLOGY_CLOSED

Static Readonly TOPOLOGY_DESCRIPTION_CHANGED

Static Readonly TOPOLOGY_OPENING

Properties属性

[kWaitQueue]

Optional _type

bson

Type declaration类型声明

deserialize: (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions) => Document

Parameters参数

buffer: Buffer | ArrayBufferView | ArrayBuffer

Optional options: DeserializeOptions

Returns返回Document

serialize: (object: Document, options?: SerializeOptions) => Buffer

Parameters参数

object: Document

Optional options: SerializeOptions

Returns返回Buffer

Optional ismaster

s

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors访问器

capabilities

Returns返回ServerCapabilities

clientMetadata

Returns返回ClientMetadata

clusterTime

Returns返回undefined | ClusterTime

Parameters参数

clusterTime: undefined | ClusterTime

Returns返回void

description

Returns返回TopologyDescription

loadBalanced

Returns返回boolean

logicalSessionTimeoutMinutes

Returns返回undefined | number

Methods方法

addListener

Type parameters类型参数

Parameters参数

event: EventKey

listener: TopologyEvents[EventKey]

Returns返回Topology

Parameters参数

event: CommonEvents

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

Parameters参数

eventName: string | symbol

listener: GenericListener

Returns返回void

Returns返回Topology

Parameters参数

event: string | symbol

listener: GenericListener