Class TopologyDescription

constructor

• new TopologyDescription(topologyType, serverDescriptions?, setName?, maxSetVersion?, maxElectionId?, commonWireVersion?, options?): TopologyDescription

• Create a TopologyDescription

  Parameters

  • topologyType: TopologyType
  • serverDescriptions: null | Map<string, ServerDescription> = null
  • setName: null | string = null
  • maxSetVersion: null | number = null
  • maxElectionId: null | ObjectId = null
  • commonWireVersion: null | number = null
  • options: null | TopologyDescriptionOptions = null

  Returns TopologyDescription

commonWireVersion

OptionalcompatibilityError

compatible

heartbeatFrequencyMS

localThresholdMS

logicalSessionTimeoutMinutes

maxElectionId

maxSetVersion

servers

setName

stale

type

error

• get error(): null | MongoError

• Returns null | MongoError

hasDataBearingServers

• get hasDataBearingServers(): boolean

• Determines if this topology description has a data-bearing server available.

  Returns boolean

hasKnownServers

• get hasKnownServers(): boolean

• Determines if the topology description has any known servers

  Returns boolean

toJSON

• toJSON(): Document

• Returns a JSON-serializable representation of the TopologyDescription. This is primarily intended for use with JSON.stringify().

  This method will not throw.

  Returns Document