An error representing the complete errors for an operation. This is a cohesive error that represents all the errors that occurred during a single operation, and should not be thought of as always 1:1 with the number of API requests—rather it's 1:1 with the number of logical operations performed by the user (i.e. the methods on the Collection class).

This is not used for "hard" (4XX, 5XX) errors, which are rarer and would be thrown directly by the underlying code.

Field

message - A human-readable message describing the first error

Field

errorDescriptors - A list of error descriptors representing the individual errors returned by the API

Field

detailedErrorDescriptors - A list of errors 1:1 with the number of errorful API requests made to the server.

Hierarchy (view full)

Constructors

Properties

detailedErrorDescriptors: DataAPIDetailedErrorDescriptor[]

A list of errors 1:1 with the number of errorful API requests made to the server. Each element contains the original command, the raw response, and the error descriptors for that request.

For operations that only make one request, this will be a singleton list (i.e. insertOne).

errorDescriptors: DataAPIErrorDescriptor[]

A list of error descriptors representing the individual errors returned by the API.

This is always equal to detailedErrorDescriptors.flatMap(d => d.errorDescriptors), for the user's convenience.

message: string

A human-readable message describing the first error.

This is always equal to errorDescriptors[0]?.message if it exists, otherwise it's given a generic default message.

name: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void