Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

address

address: string

type

type: <internal>.ServerType

hosts

hosts: string[]

passives

passives: string[]

arbiters

arbiters: string[]

tags

tags: TagSet

error

error: MongoError

topologyVersion

topologyVersion: TopologyVersion

minWireVersion

minWireVersion: number

maxWireVersion

maxWireVersion: number

roundTripTime

roundTripTime: number

lastUpdateTime

lastUpdateTime: number

lastWriteDate

lastWriteDate: number

me

me: string

primary

primary: string

setName

setName: string

setVersion

setVersion: number

electionId

electionId: <internal>.ObjectId

logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes: number

Optional $clusterTime

$clusterTime?: ClusterTime

Accessors

hostAddress

  • Returns HostAddress

allHosts

  • get allHosts(): string[]

  • Returns string[]

isReadable

  • get isReadable(): boolean

  • Is this server available for reads

    Returns boolean

isDataBearing

  • get isDataBearing(): boolean

  • Is this server data bearing

    Returns boolean

isWritable

  • get isWritable(): boolean

  • Is this server available for writes

    Returns boolean

host

  • get host(): string

  • Returns string

port

  • get port(): number

  • Returns number

Methods

equals

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

    Parameters

    Returns boolean

Generated using TypeDoc