Internal Should not be instantiated by the user.
Readonly commandThe original command that was sent to the API, as a plain object. This is the raw command, not necessarily in the exact format the client may use, in some rare cases.
{
insertOne: {
document: { _id: 'doc10', name: 'Document 10' },
},
}
Readonly messageA 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.
Readonly rawThe raw response from the API
{
status: {
insertedIds: [ 'id1', 'id2', 'id3']
},
errors: [
{
family: 'REQUEST',
scope: 'DOCUMENT',
errorCode: 'DOCUMENT_ALREADY_EXISTS',
id: 'e4be94b6-e8b5-4652-961b-5c9fe12d2f1a',
title: 'Document already exists with the given _id',
message: 'Document already exists with the given _id',
},
]
}
Optional stackStatic stackThe Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
A list of error descriptors representing the individual errors returned by the API.
This will likely be a singleton list in many cases, such as for insertOne or deleteOne commands, but may be
longer for bulk operations like insertMany which may have multiple insertion errors.
A list of error descriptors representing the individual errors returned by the API.
This will likely be a singleton list in many cases, such as for insertOne or deleteOne commands, but may be
longer for bulk operations like insertMany which may have multiple insertion errors.
Static captureCreates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
Optional constructorOpt: FunctionStatic prepare
Overview
An error representing a 2XX error returned from the Data API (such as duplicate ID errors, certain validation errors, etc.)