Class MongoWriteConcernError

An error thrown when the server reports a writeConcernError

Hierarchy

Constructors

constructor

Properties

cause? code? codeName? connectionGeneration? errInfo? errorResponse message ok? result stack? topologyVersion? writeConcernError? prepareStackTrace? stackTraceLimit

Accessors

errmsg errorLabels name

Methods

addErrorLabel hasErrorLabel captureStackTrace

Constructors

constructor

  • Do not use this constructor!

    Meant for internal use only.

    Parameters

    • result: {
          errorLabels?: string[];
          writeConcernError: {
              code: number;
              codeName?: string;
              errInfo?: Document;
              errmsg: string;
          };
      }
      • Optional errorLabels?: string[]
      • writeConcernError: {
            code: number;
            codeName?: string;
            errInfo?: Document;
            errmsg: string;
        }
        • code: number
        • Optional codeName?: string
        • Optional errInfo?: Document
        • errmsg: string

    Returns MongoWriteConcernError

    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 codeName

codeName?: string

Optional connectionGeneration

connectionGeneration?: number

Optional errInfo

errInfo?: Document

errorResponse

errorResponse: ErrorDescription

Raw error result document returned by server.

message

message: string

Optional ok

ok?: number

result

result: Document

The result document

Optional stack

stack?: string

Optional topologyVersion

topologyVersion?: TopologyVersion

Optional writeConcernError

writeConcernError?: Document

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