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

$clusterTime? address arbiters electionId error hosts iscryptd lastUpdateTime lastWriteDate logicalSessionTimeoutMinutes maxBsonObjectSize maxMessageSizeBytes maxWireVersion maxWriteBatchSize me minRoundTripTime minWireVersion passives primary roundTripTime setName setVersion tags topologyVersion type

Accessors

allHosts host hostAddress isDataBearing isReadable isWritable port

Methods

equals

Properties

Optional$clusterTime

$clusterTime?: ClusterTime

address

address: string

arbiters

arbiters: string[]

electionId

electionId: null | ObjectId

error

error: null | MongoError

hosts

hosts: string[]

iscryptd

iscryptd: boolean

Indicates server is a mongocryptd instance.

lastUpdateTime

lastUpdateTime: number

lastWriteDate

lastWriteDate: number

logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes: null | number

maxBsonObjectSize

maxBsonObjectSize: null | number

The max bson object size.

maxMessageSizeBytes

maxMessageSizeBytes: null | number

The max message size in bytes for the server.

maxWireVersion

maxWireVersion: number

maxWriteBatchSize

maxWriteBatchSize: null | number

The max number of writes in a bulk write command.

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

tags

tags: TagSet

topologyVersion

topologyVersion: null | TopologyVersion

type

type: ServerType

Accessors

allHosts

  • get allHosts(): string[]

  • Returns string[]

host

  • get host(): string

  • Returns string

hostAddress

isDataBearing

  • get isDataBearing(): boolean

  • Is this server data bearing

    Returns boolean

isReadable

  • get isReadable(): boolean

  • Is this server available for reads

    Returns boolean

isWritable

  • get isWritable(): boolean

  • Is this server available for writes

    Returns boolean

port

  • get port(): number

  • Returns number

Methods

equals

Settings

Member Visibility

On This Page

Properties
Accessors
Methods