@nats-io/nats-core
    Preparing search index...

    Class UnhandledCallbackError

    UnhandledCallbackError wraps a value thrown or rejected by user code the client called - a callback, or one that returns a value the client must act on, such as an authenticator - that the user's code didn't handle. The client contains it: the message says where it failed and what was thrown, and the cause is the original value, as thrown, even if it is not an Error.

    Callbacks that fail are printed to the console as an UnhandledCallbackError and the client continues. Callbacks that return a value the client must act on fail the operation, with the error thrown, or an UnhandledCallbackError if what was thrown is not an Error.

    Hierarchy

    • Error
      • UnhandledCallbackError
    Index
    • Parameters

      • where: string
      • cause: unknown

      Returns UnhandledCallbackError

    cause?: unknown
    message: string
    name: string
    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.

    • 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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error