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:231
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:382
Returns ServerCapabilities

clientMetadata

get clientMetadata(): ClientMetadata

- Defined in src/sdam/topology.ts:740
Returns ClientMetadata

clusterTime

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

- Defined in src/sdam/topology.ts:774
Returns undefined | ClusterTime
- Defined in src/sdam/topology.ts:778
Parameters
- clusterTime: undefined | ClusterTime
Returns void

description

get description(): TopologyDescription

- Defined in src/sdam/topology.ts:378
Returns TopologyDescription

A TopologyDescription for this topology

logicalSessionTimeoutMinutes

get logicalSessionTimeoutMinutes(): undefined | number

- Defined in src/sdam/topology.ts:770
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:342
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:343
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:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns Topology

auth

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

- Defined in src/sdam/topology.ts:735
Parameters
- Optional credentials: MongoCredentials
- Optional callback: Callback<any>
Returns void

close

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

- Defined in src/sdam/topology.ts:454
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:387
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:340
Parameters
- event: TopologyDescriptionChangedEvent
Returns void

Private detectSrvRecords

detectSrvRecords(ev: SrvPollingEvent): void

- Defined in src/sdam/topology.ts:355
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:389
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:628
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:415
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:416
Returns number

hasSessionSupport

hasSessionSupport(): boolean

- Defined in src/sdam/topology.ts:612
Returns boolean

Whether sessions are supported on the current topology

isConnected

isConnected(): boolean

- Defined in src/sdam/topology.ts:744
Returns boolean

isDestroyed

isDestroyed(): boolean

- Defined in src/sdam/topology.ts:748
Returns boolean

lastIsMaster

lastIsMaster(): Document

- Defined in src/sdam/topology.ts:759
Returns Document

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
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:381
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:370
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:371
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:375
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:349
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:350
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:354
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:356
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:357
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:361
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:398
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:399
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:403
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:405
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:409
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:413
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:385
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:377
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:363
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:364
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:368
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:517
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:518
Parameters
- selector: string | ReadPreference | ServerSelector
- callback: Callback<Server>
Returns void
- Defined in src/sdam/topology.ts:522
Parameters
- selector: string | ReadPreference | ServerSelector
- options: SelectServerOptions
- callback: Callback<Server>
Returns void

serverUpdateHandler

serverUpdateHandler(serverDescription: ServerDescription): void

- Defined in src/sdam/topology.ts:658
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:417
Parameters
- n: number
Returns Topology

shouldCheckForSessionSupport

shouldCheckForSessionSupport(): boolean

- Defined in src/sdam/topology.ts:601
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:617
Start a logical session

Parameters
- options: ClientSessionOptions
- Optional clientOptions: MongoOptions
Returns ClientSession

unref

unref(): void

- Defined in src/sdam/topology.ts:752
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

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

Returns Topology

auth