Class BSONError

Hierarchy

Error
- BSONError
  - BSONVersionError
  - BSONRuntimeError

Index

Constructors

Properties

cause? message stack? prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace isBSONError

Constructors

constructor

new BSONError(message): BSONError
Parameters
- message: string
Returns BSONError
Overrides Error.constructor
- Defined in packages/@biorate/mongodb/node_modules/bson/bson.d.ts:171

Properties

`Optional` cause

cause?: unknown

message

message: string

`Optional` stack

stack?: string

`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

name

get name(): string
Returns string
Overrides Error.name
- Defined in packages/@biorate/mongodb/node_modules/bson/bson.d.ts:170

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
  Optional
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@16.18.114/node_modules/@types/node/globals.d.ts:4

`Static` isBSONError

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
- Defined in packages/@biorate/mongodb/node_modules/bson/bson.d.ts:181

Generated using TypeDoc