kinetex - v1.0.0-rc.1
    Preparing search index...

    Class HTTPResponseError

    Thrown when a response has an HTTP error status (4xx/5xx).

    Hierarchy

    • Error
      • HTTPResponseError
    Index

    Constructors

    • Parameters

      • status: number
      • statusText: string
      • url: string
      • headers: Record<string, string>
      • body: string | null

      Returns HTTPResponseError

    Properties

    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.

    code: "EHTTPRESPONSE"

    Human-readable error code.

    status: number

    The HTTP status code.

    statusText: string

    The HTTP status text.

    url: string

    The URL of the failed request.

    headers: Record<string, string>

    The normalized response headers.

    body: string | null

    The response body, or null if not read.

    cause?: unknown
    name: string
    message: string
    stack?: string

    Accessors

    • get isClientError(): boolean

      Returns true if the status code is a client error (4xx).

      Returns boolean

    • get isServerError(): boolean

      Returns true if the status code is a server error (5xx).

      Returns boolean

    • get isNotFound(): boolean

      Returns true if the status is 404 Not Found.

      Returns boolean

    • get isUnauthorized(): boolean

      Returns true if the status is 401 Unauthorized.

      Returns boolean

    • get isForbidden(): boolean

      Returns true if the status is 403 Forbidden.

      Returns boolean

    • get isTooManyRequests(): boolean

      Returns true if the status is 429 Too Many Requests.

      Returns boolean

    • get isGone(): boolean

      Returns true if the status is 410 Gone.

      Returns boolean

    • get isConflict(): boolean

      Returns true if the status is 409 Conflict.

      Returns boolean

    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