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

Hierarchy

  • ServerDescription

Constructors

constructor

Properties

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

Accessors

allHosts host hostAddress isDataBearing isReadable isWritable port

Methods

equals

Constructors

constructor

Properties

Optional $clusterTime

$clusterTime?: ClusterTime

address

address: string

arbiters

arbiters: string[]

electionId

electionId: mongoose.mongo.BSON.ObjectId

error

error: MongoError

hosts

hosts: string[]

lastUpdateTime

lastUpdateTime: number

lastWriteDate

lastWriteDate: number

logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes: number

maxWireVersion

maxWireVersion: number

me

me: string

minWireVersion

minWireVersion: number

passives

passives: string[]

primary

primary: string

roundTripTime

roundTripTime: number

setName

setName: string

setVersion

setVersion: number

tags

tags: mongoose.mongo.TagSet

topologyVersion

topologyVersion: TopologyVersion

type

type: mongoose.mongo.ServerType

Accessors

allHosts

  • get allHosts(): string[]

  • Returns string[]

host

  • get host(): string

  • Returns string

hostAddress

  • get hostAddress(): HostAddress

  • Returns 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

  • Determines if another ServerDescription is equal to this one per the rules defined in the spec

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc