Class MongoServerSelectionError

An error signifying a client-side server selection error

Hierarchy

MongoSystemError
- MongoServerSelectionError

Index

Constructors

Properties

cause? code? connectionGeneration? message reason? stack? topologyVersion? prepareStackTrace? stackTraceLimit

Accessors

errmsg errorLabels name

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

new MongoServerSelectionError(message, reason): MongoServerSelectionError
Do not use this constructor!

Meant for internal use only.
Parameters
- message: string
- reason: TopologyDescription
Returns MongoServerSelectionError

Remarks
This class is only meant to be constructed within the driver. This constructor is not subject to semantic versioning compatibility guarantees and may change at any time.
Overrides MongoSystemError.constructor
- Defined in src/error.ts:1152

Properties

`Optional` cause

cause?: Error

`Optional` code

code?: string | number

This is a number in MongoServerError and a string in MongoDriverError

`Optional` connectionGeneration

connectionGeneration?: number

message

message: string

`Optional` reason

reason?: TopologyDescription

An optional reason context, such as an error saved during flow of monitoring and selecting servers

`Optional` stack

stack?: string

`Optional` topologyVersion

topologyVersion?: TopologyVersion

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

errmsg

get errmsg(): string
Legacy name for server error responses

Returns string
Inherited from MongoSystemError.errmsg
- Defined in src/error.ts:175

errorLabels

get errorLabels(): string[]
Returns string[]
Inherited from MongoSystemError.errorLabels
- Defined in src/error.ts:193

name

get name(): string
Returns string
Overrides MongoSystemError.name
- Defined in src/error.ts:1156

Methods

addErrorLabel

addErrorLabel(label): void
Parameters
- label: string
Returns void
Inherited from MongoSystemError.addErrorLabel
- Defined in src/error.ts:189

hasErrorLabel

hasErrorLabel(label): boolean
Checks the error to see if it has an error label
Parameters
- label: string
  
  The error label to check for
Returns boolean
returns true if the error has the provided error label
Inherited from MongoSystemError.hasErrorLabel
- Defined in src/error.ts:185

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from MongoSystemError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc