kutt - v4.0.0
    Preparing search index...

    Class HTTPError

    Error returned when an HTTP request receives an unsuccessful response.

    API requests set the message to the response body, preserve the HTTP status, and include the response Headers object in metadata.headers.

    import { HTTPError, isKuttHealthyV2 } from "kutt";

    try {
      await isKuttHealthyV2();
    } catch (error) {
      if (HTTPError.isHTTPError(error)) {
        console.error(error.status, error.message);
      }
    }

    Hierarchy

    • Error
      • HTTPError
    Index
    constructor
    cause? message metadata? name stack? status stackTraceLimit
    captureStackTrace isError isHTTPError prepareStackTrace

    • Creates an HTTP error with a status code and optional metadata.

      Parameters

      • message: string

        Error message. API requests use the response body as text.

      • status: number

        HTTP response status code.

      • Optionalmetadata: { [key: string]: unknown }

        Additional error details. API requests provide response headers as headers.

      Returns HTTPError

    cause?: unknown
    message: string
    metadata?: { [key: string]: unknown }

    Additional error details. API requests provide response headers as headers.

    name: string = "HTTPError"

    Error name used to identify this class in error output.

    stack?: string
    status: number

    HTTP response status code.

    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

    • Checks whether a value is an instance of this HTTP error class.

      Parameters

      • value: unknown

        Value to inspect.

      Returns value is HTTPError

      Whether the value is an HTTPError, narrowing its type when true.

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods