@oneblink/storage
    Preparing search index...

    Class OneBlinkStorageError

    An error class that extends Error

    Hierarchy

    • Error
      • OneBlinkStorageError
    Index

    Constructors

    • Used to create an instance of the OneBlinkStorageError class.

      Parameters

      • message: string

        The message associated with the error

      • options: { httpStatusCode: number; originalError?: Error }

        The options associated with the error

        • httpStatusCode: number

          The http status code associated with the error

        • OptionaloriginalError?: Error

          The original error that was thrown

      Returns OneBlinkStorageError

    Properties

    cause?: unknown
    httpStatusCode: number

    The http status code associated with the error

    message: string
    name: string
    originalError?: Error

    The original error that was thrown

    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