@karmaniverous/jeeves
    Preparing search index...

    Class CatalogClientError

    A failed catalog request: invalid input, a non-2xx response, a response that doesn't match its schema, or no response at all. Components' SDKs may subclass it (e.g. the watcher's WatcherError).

    Hierarchy

    • Error
      • CatalogClientError
    Index
    body?: { error: string; [key: string]: unknown }

    Error body of a non-2xx response.

    Type Declaration

    • [key: string]: unknown
    • error: string

      Human-readable error message.

    cause?: unknown
    headers?: Headers

    Headers of the response; absent when none was received (status 0).

    issues?: $ZodIssue[]

    Zod issues, when validation failed.

    message: string
    name: string
    retryAfterMs?: number

    Milliseconds to wait before retrying, from the response's Retry-After (delta-seconds, or an HTTP date relative to when the error was built); absent when the header is missing or unparseable.

    Not capped: a server may ask for days. Cap it before passing it to setTimeout, which fires delays above 2^31-1 ms (about 24.8 days) after 1 ms.

    stack?: string
    status: number

    HTTP status; 0 when no response was received or input was invalid.

    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