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

    Class HTTPStatusError

    Thrown when the server returns a 4xx or 5xx status.

    The HTTP response that caused the error.

    The request that produced the response.

    Hierarchy (View Summary)

    Index

    Constructors

    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: KinetexErrorCode

    Machine-readable error code.

    Original request, if available.

    response?: KinetexResponse<unknown>

    Response, if available (for HTTP-level errors).

    cause?: unknown

    Underlying cause.

    name: string
    message: string
    stack?: string

    Accessors

    • get isNetwork(): boolean

      True if the error is a network/transport failure (not proxy-related).

      Returns boolean

    • get isProxy(): boolean

      True if the error is a proxy-related failure.

      Returns boolean

    • get isTimeout(): boolean

      True if the error is a timeout.

      Returns boolean

    • get isAbort(): boolean

      True if the request was aborted by the caller.

      Returns boolean

    • get isHTTPError(): boolean

      True if the server returned a 4xx or 5xx status.

      Returns boolean

    • get status(): number | null

      HTTP status code shorthand (null for non-HTTP errors).

      Returns number | null

    • get isClientError(): boolean

      True if the status is a 4xx client error.

      Returns boolean

    • get isServerError(): boolean

      True if the status is a 5xx server error.

      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