Class MongoGCPError

A error generated when the user attempts to authenticate via GCP, but fails.

Hierarchy

Constructors

constructor

Properties

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

Accessors

errmsg errorLabels name

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

  • Do not use this constructor!

    Meant for internal use only.

    Parameters

    • message: string

    Returns MongoGCPError

    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

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

Static stackTraceLimit

stackTraceLimit: number

Accessors

errmsg

  • get errmsg(): string

  • Legacy name for server error responses

    Returns string

errorLabels

  • get errorLabels(): string[]

  • Returns string[]

name

  • get name(): string

  • Returns string

Methods

addErrorLabel

hasErrorLabel

  • 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

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc