Server | mongodb

internal

Hierarchy

TypedEventEmitter<ServerEvents>
- Server

Index

Constructors

constructor

Events

Properties

Accessors

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