qfetch
    Preparing search index...

    Class ResponseError

    Default error thrown for failed HTTP responses.

    Contains response metadata for error handling. The full Response object is preserved, allowing consumers to read the body if needed.

    try {
      await qfetch("/api/users/123");
    } catch (error) {
      if (error instanceof ResponseError) {
        console.log(error.status); // 404
        console.log(error.url); // "/api/users/123"
        const body = await error.response.json();
      }
    }

    Hierarchy

    • Error
      • ResponseError
    Index

    Constructors

    constructor

    Properties

    cause? message name response stack? status statusText url stackTraceLimit

    Methods

    captureStackTrace isError prepareStackTrace

    Constructors

    • Creates a new ResponseError.

      Parameters

      • response: Response

        The HTTP response that triggered the error

      • Optionaloptions: ErrorOptions

        Standard Error options, including cause for error chaining

      Returns ResponseError

    Properties

    cause?: unknown
    message: string
    name: string
    response: Response

    The full response object, allowing body reading if needed.

    stack?: string
    status: number

    The HTTP status code of the response.

    statusText: string

    The HTTP status text of the response.

    url: string

    The URL of the request that failed.

    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

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    • 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