Class CollectionUpdateManyError

Overview

Represents an error that occurred during an updateMany operation (which is, generally, paginated).

Contains the number of documents that were successfully matched and/or modified, as well as the cumulative errors that occurred during the operation.

Example

try {
  await collection.updateMany({ age: 30 }, { $inc: { age: 1 } });
} catch (e) {
  if (e instanceof CollectionUpdateManyError) {
    console.log(e.cause);
    console.log(e.partialResult);
  }
}

See

Collection.updateMany

Hierarchy (view full)

Constructors

constructor

Properties

cause message name partialResult stack? stackTraceLimit

Methods

withTransientDupesForEvents captureStackTrace prepareStackTrace

Constructors

constructor

Properties

Readonly cause

cause: Error

The error that caused the operation to fail.

message

message: string

name

name: string = 'CollectionUpdateManyError'

The name of the error. This is always 'UpdateManyError'.

Readonly partialResult

partialResult: CollectionUpdateManyResult<SomeDoc>

The partial result of the UpdateMany operation that was performed. This is always defined, and is the result of the operation up to the point of the first error.

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

The 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.

Methods

withTransientDupesForEvents

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Creates 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();

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static prepareStackTrace

Settings

Member Visibility

Theme

On This Page

constructorcausemessagenamepartialResultstackstackTraceLimitwithTransientDupesForEventscaptureStackTraceprepareStackTrace