Class ServerDescription

The client's view of a single server, based on the most recent hello outcome.

Internal type, not meant to be directly instantiated

Properties

`Optional`$clusterTime

$clusterTime?: ClusterTime

address

address: string

arbiters

arbiters: string[]

electionId

electionId: null | ObjectId

error

error: null | MongoError

hosts

hosts: string[]

lastUpdateTime

lastUpdateTime: number

lastWriteDate

lastWriteDate: number

logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes: null | number

maxWireVersion

maxWireVersion: number

me

me: null | string

minRoundTripTime

minRoundTripTime: number

The minimum measurement of the last 10 measurements of roundTripTime that have been collected

minWireVersion

minWireVersion: number

passives

passives: string[]

primary

primary: null | string

roundTripTime

roundTripTime: number

setName

setName: null | string

setVersion

setVersion: null | number

topologyVersion

topologyVersion: null | TopologyVersion

type

type: ServerType

Accessors

allHosts

get allHosts(): string[]
Returns string[]
- Defined in src/sdam/server_description.ts:123

host

get host(): string
Returns string
- Defined in src/sdam/server_description.ts:142

hostAddress

get hostAddress(): HostAddress
Returns HostAddress
- Defined in src/sdam/server_description.ts:119

isDataBearing

get isDataBearing(): boolean
Is this server data bearing

Returns boolean
- Defined in src/sdam/server_description.ts:133

isReadable

get isReadable(): boolean
Is this server available for reads

Returns boolean
- Defined in src/sdam/server_description.ts:128

isWritable

get isWritable(): boolean
Is this server available for writes

Returns boolean
- Defined in src/sdam/server_description.ts:138

port

get port(): number
Returns number
- Defined in src/sdam/server_description.ts:147

Methods

equals

equals(other?): boolean
Determines if another ServerDescription is equal to this one per the rules defined in the spec
Parameters
- Optionalother: null | ServerDescription
Returns boolean
- Defined in src/sdam/server_description.ts:156

Class ServerDescription

Index

Properties

Accessors

Methods

Properties

Optional$clusterTime

address

arbiters

electionId

error

hosts

lastUpdateTime

lastWriteDate

logicalSessionTimeoutMinutes

maxWireVersion

me

minRoundTripTime

minWireVersion

passives

primary

roundTripTime

setName

setVersion

tags

topologyVersion

type

Accessors

allHosts

Returns string[]

host

Returns string

hostAddress

Returns HostAddress

isDataBearing

Returns boolean

isReadable

Returns boolean

isWritable

Returns boolean

port

Returns number

Methods

equals

Parameters

Returns boolean

Settings

On This Page

`Optional`$clusterTime