Class MongoSystemError

An error signifying a general system issue

Hierarchy

MongoError
- 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 MongoSystemError(message, reason): MongoSystemError
Do not use this constructor!

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

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 MongoError.constructor
- Defined in src/error.ts:1037

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 MongoError.errmsg
- Defined in src/error.ts:170

errorLabels

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

name

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

Methods

addErrorLabel

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

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 MongoError.hasErrorLabel
- Defined in src/error.ts:180

`Static` captureStackTrace

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

Generated using TypeDoc