Class TypeGuardError<T>

message

name

Optionalstack

StaticstackTraceLimit

StaticcaptureStackTrace

• captureStackTrace(targetObject: object, constructorOpt?: Function): 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`
  Copy

  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();
  Copy

  Parameters

  • targetObject: object
  • OptionalconstructorOpt: Function

  Returns void

StaticprepareStackTrace

• prepareStackTrace(err: Error, stackTraces: CallSite[]): any

  Parameters

  • err: Error
  • stackTraces: CallSite[]

  Returns any

  See

  https://v8.dev/docs/stack-trace-api#customizing-stack-traces