Class BSONError

Hierarchy (view full)

Constructors

constructor

Properties

cause? message stack? prepareStackTrace? stackTraceLimit

Accessors

name

Methods

captureStackTrace isBSONError

Constructors

constructor

  • new BSONError(message, options?): BSONError

  • Parameters

    • message: string
    • Optionaloptions: {
          cause?: unknown;
      }
      • Optionalcause?: unknown

    Returns BSONError

Properties

Optionalcause

cause?: unknown

message

message: string

Optionalstack

stack?: string

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

name

  • get name(): string

  • Returns string

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

StaticisBSONError

  • isBSONError(value): value is BSONError

  • All errors thrown from the BSON library inherit from BSONError. This method can assist with determining if an error originates from the BSON library even if it does not pass an instanceof check against this class' constructor.

    Parameters

    • value: unknown

      any javascript value that needs type checking

    Returns value is BSONError

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods