Member Junction
    Preparing search index...

    An explicit row cap (maxRows / MaxRows) smaller than the rows the read matches (decision D2-C1): training and scoring refuse instead of silently working on a sample. One class, so both paths share one truncation rule and callers branch on instanceof and the structured fields, never on the message.

    Hierarchy

    • Error
      • ReadCapExceededError
    Index

    Constructors

    Properties

    cause?: unknown
    EntityName: string
    MaxRows: number
    message: string
    name: string
    RowsMatched: number
    RowsRead: number
    stack?: string
    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

    • 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
      • OptionalconstructorOpt: Function

      Returns void

    • True when an explicit cap cut the read short: the database matched more rows than the capped read returned. No cap means the read was uncapped (IgnoreMaxRows), so it can never truncate. Narrows maxRows to number, so callers need no cap check of their own.

      Parameters

      • maxRows: number
      • rowsRead: number
      • rowsMatched: number

      Returns maxRows is number

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any