Connection | mongodb

internal

Hierarchy

TypedEventEmitter<ConnectionEvents>
- Connection

Index

Constructors

constructor

Events

Accessors

Constructors

constructor

new Connection(stream: Stream, options: ConnectionOptions): Connection

Overrides TypedEventEmitter.constructor
- Defined in src/cmap/connection.ts:196
Parameters
- stream: Stream
- options: ConnectionOptions
Returns Connection

Events

Static Readonly CLOSE

CLOSE: "close" = ...

Static Readonly CLUSTER_TIME_RECEIVED

CLUSTER_TIME_RECEIVED: "clusterTimeReceived" = ...

Static Readonly COMMAND_FAILED

COMMAND_FAILED: "commandFailed" = ...

Static Readonly COMMAND_STARTED

COMMAND_STARTED: "commandStarted" = ...

Static Readonly COMMAND_SUCCEEDED

COMMAND_SUCCEEDED: "commandSucceeded" = ...

Static Readonly MESSAGE

MESSAGE: "message" = ...

Properties

[kClusterTime]

[kClusterTime]: Document

internal

[kDescription]

[kDescription]: StreamDescription

internal

[kGeneration]

[kGeneration]: number

internal

[kIsMaster]

[kIsMaster]: Document

internal

[kLastUseTime]

[kLastUseTime]: number

internal

[kMessageStream]

[kMessageStream]: MessageStream

internal

[kQueue]

[kQueue]: Map<number, OperationDescription>

internal

[kStream]

[kStream]: Stream

internal

address

address: string

closed

closed: boolean

destroyed

destroyed: boolean

Optional helloOk

helloOk: boolean

id

id: number | "<monitor>"

Optional lastIsMasterMS

lastIsMasterMS: number

monitorCommands

monitorCommands: boolean

Optional serverApi

serverApi: ServerApi

socketTimeoutMS

socketTimeoutMS: number

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

clusterTime

get clusterTime(): Document

- Defined in src/cmap/connection.ts:258
Returns Document

description

get description(): StreamDescription

- Defined in src/cmap/connection.ts:233
Returns StreamDescription

generation

get generation(): number

- Defined in src/cmap/connection.ts:250
Returns number

idleTime

get idleTime(): number

- Defined in src/cmap/connection.ts:254
Returns number

ismaster

get ismaster(): Document
set ismaster(response: Document): void

- Defined in src/cmap/connection.ts:237
Returns Document
- Defined in src/cmap/connection.ts:242
Parameters
- response: Document
Returns void

stream

get stream(): Stream

- Defined in src/cmap/connection.ts:262
Returns Stream

Methods

addListener

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

Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

command

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

- Defined in src/cmap/connection.ts:338
internal

Parameters
- ns: MongoDBNamespace
- cmd: Document
- options: undefined | CommandOptions
- callback: Callback<any>
Returns void

destroy

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

- Defined in src/cmap/connection.ts:299
Returns void
- Defined in src/cmap/connection.ts:300
Parameters
- callback: Callback<any>
Returns void
- Defined in src/cmap/connection.ts:301
Parameters
- options: DestroyOptions
Returns void
- Defined in src/cmap/connection.ts:302
Parameters
- options: DestroyOptions
- callback: Callback<any>
Returns void

emit

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

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<ConnectionEvents[EventKey]>
Returns boolean

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

getMore

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

- Defined in src/cmap/connection.ts:525
internal

Parameters
- ns: MongoDBNamespace
- cursorId: Long
- options: GetMoreOptions
- callback: Callback<Document>
Returns void

handleIssue

handleIssue(issue: { destroy?: boolean | Error; isClose?: boolean; isTimeout?: boolean }): void

- Defined in src/cmap/connection.ts:270
Parameters
- issue: { destroy?: boolean | Error; isClose?: boolean; isTimeout?: boolean }
  - Optional destroy?: boolean | Error
  - Optional isClose?: boolean
  - Optional isTimeout?: boolean
Returns void

killCursors

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

- Defined in src/cmap/connection.ts:581
internal

Parameters
- ns: MongoDBNamespace
- cursorIds: Long[]
- options: CommandOptions
- callback: Callback<any>
Returns void

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- type: string | symbol | EventKey
Returns number

listeners

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

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: string | symbol | EventKey
Returns ConnectionEvents[EventKey][]

markAvailable

markAvailable(): void

- Defined in src/cmap/connection.ts:266
Returns void

off

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

Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

on

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

Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

once

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

Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

prependListener

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

Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

prependOnceListener

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

Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:405
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

query

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

- Defined in src/cmap/connection.ts:452
internal

Parameters
- ns: MongoDBNamespace
- cmd: Document
- options: QueryOptions
- callback: Callback<any>
Returns void

rawListeners

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

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: string | symbol | EventKey
Returns ConnectionEvents[EventKey][]

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- Optional event: string | symbol | EventKey
Returns Connection

removeListener

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

Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Type parameters
- EventKey: keyof ConnectionEvents
Parameters
- event: EventKey
- listener: ConnectionEvents[EventKey]
Returns Connection
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 Connection
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns Connection

setMaxListeners

setMaxListeners(n: number): Connection

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:417
Parameters
- n: number
Returns Connection

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

stream: Stream

options: ConnectionOptions

Returns Connection

Events

Static Readonly CLOSE

Static Readonly CLUSTER_TIME_RECEIVED

Static Readonly COMMAND_FAILED

Static Readonly COMMAND_STARTED

Static Readonly COMMAND_SUCCEEDED

Static Readonly MESSAGE

Properties

[kClusterTime]

[kDescription]

[kGeneration]

[kIsMaster]

[kLastUseTime]

[kMessageStream]

[kQueue]

[kStream]

address

closed

destroyed

Optional helloOk

id

Optional lastIsMasterMS

monitorCommands

Optional serverApi

socketTimeoutMS

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

clusterTime

Returns Document

description

Returns StreamDescription

generation

Returns number

idleTime

Returns number

ismaster

Returns Document

Parameters

response: Document

Returns void

stream

Returns Stream

Methods

addListener

Type parameters

EventKey: keyof ConnectionEvents

Parameters

event: EventKey

listener: ConnectionEvents[EventKey]

Returns Connection

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns Connection

Parameters

event: string | symbol

listener: GenericListener

Returns Connection

command

Parameters