Class MongoCryptError

An error indicating that something went wrong specifically with MongoDB Client Encryption

Hierarchy (view full)

Constructors

constructor

Properties

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

Accessors

errmsg errorLabels name

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

  • new MongoCryptError(message, options?): MongoCryptError

  • Do not use this constructor!

    Meant for internal use only.

    Parameters

    • message: string
    • options: {
          cause?: Error;
      } = {}
      • Optionalcause?: Error

    Returns MongoCryptError

    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.

Properties

Optionalcause

cause?: Error

Optionalcode

code?: string | number

This is a number in MongoServerError and a string in MongoDriverError

OptionalconnectionGeneration

connectionGeneration?: number

message

message: string

Optionalstack

stack?: string

OptionaltopologyVersion

topologyVersion?: TopologyVersion

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Accessors

errmsg

  • get errmsg(): string

  • Legacy name for server error responses

    Returns string

errorLabels

  • get errorLabels(): string[]

  • Returns string[]

name

Methods

addErrorLabel

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

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods