Class MongoCryptAzureKMSRequestError

An error indicating that mongodb-client-encryption failed to auto-refresh Azure KMS credentials.

Hierarchy

MongoCryptError
- MongoCryptAzureKMSRequestError

Index

Constructors

Properties

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

Accessors

errmsg errorLabels name

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

new MongoCryptAzureKMSRequestError(message, body?): MongoCryptAzureKMSRequestError
Do not use this constructor!

Meant for internal use only.
Parameters
- message: string
- Optional body: Document
Returns MongoCryptAzureKMSRequestError

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 MongoCryptError.constructor
- Defined in src/client-side-encryption/errors.ts:126

Properties

`Optional` body

body?: Document

The body of the http response that failed, if present.

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

errorLabels

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

name

get name(): string
Returns string
Overrides MongoCryptError.name
- Defined in src/client-side-encryption/errors.ts:131

Methods

addErrorLabel

addErrorLabel(label): void
Parameters
- label: string
Returns void
Inherited from MongoCryptError.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 MongoCryptError.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 MongoCryptError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc