Logos DX
    Preparing search index...

    Class FetchError<T, H>

    Type Parameters

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    aborted? attempt? cause? data headers? message method name path requestId? stack? status step? timedOut? url? stackTraceLimit

    Methods

    isCancelled isConnectionLost isTimeout captureStackTrace isError prepareStackTrace

    Constructors

    Properties

    aborted?: boolean

    Whether the request was aborted (any cause: manual, timeout, or server).

    attempt?: number
    cause?: unknown
    data: T | null
    headers?: H
    message: string
    method: string
    name: string
    path: string
    requestId?: string
    stack?: string
    status: number
    step?: "response" | "fetch" | "parse"
    timedOut?: boolean

    Whether the request was aborted due to a timeout (attemptTimeout or totalTimeout). When true, aborted will also be true. When false but aborted is true, the abort was manual or server-initiated.

    url?: 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

    • Returns true if the request was intentionally cancelled by the client (not due to a timeout). This indicates a user/app initiated abort.

      Use this to distinguish between "user navigated away" vs "request failed".

      Returns boolean

      true if manually aborted, false otherwise

      const [res, err] = await attempt(() => api.get('/data'));
      if (err?.isCancelled()) {
          // User cancelled - don't show error, don't log
          return;
      }

    • Returns true if the connection was lost (server dropped, network failed, etc.). This indicates the failure was NOT initiated by the client.

      Use this to show "connection lost" messages or trigger offline mode.

      Returns boolean

      true if connection was lost, false otherwise

      const [res, err] = await attempt(() => api.get('/data'));
      if (err?.isConnectionLost()) {
          toast.error('Connection lost. Check your internet.');
      }

    • Returns true if the request timed out (either attemptTimeout or totalTimeout).

      Use this to show "request timed out" messages or decide whether to retry.

      Returns boolean

      true if a timeout fired, false otherwise

      const [res, err] = await attempt(() => api.get('/data'));
      if (err?.isTimeout()) {
          toast.warn('Request timed out. Retrying...');
      }

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods