Class TooManyDocumentsToCountError

Overview

Caused by a Collection.countDocuments operation that failed because the resulting number of documents exceeded either the upper bound set by the caller, or the hard limit imposed by the Data API.

Example

await collections.insertMany('<100_length_array>');

try {
  await collections.countDocuments({}, 50);
} catch (e) {
  if (e instanceof TooManyDocumentsToCountError) {
    console.log(e.limit); // 50
    console.log(e.hitServerLimit); // false
  }
}

See

Collection.countDocuments

Hierarchy (view full)

Constructors

constructor

Properties

hitServerLimit limit message name stack? stackTraceLimit

Methods

withTransientDupesForEvents captureStackTrace prepareStackTrace

Constructors

constructor

Properties

Readonly hitServerLimit

hitServerLimit: boolean

Specifies if the server-imposed limit was hit. If this is true, the limit field will contain the server's limit; otherwise it will contain the caller's limit.

Readonly limit

limit: number

The limit that was specified by the caller, or the server-imposed limit if the caller's limit was too high.

message

message: string

name

name: string

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

constructorhitServerLimitlimitmessagenamestackstackTraceLimitwithTransientDupesForEventscaptureStackTraceprepareStackTrace