@maschinenlesbar.org/fit-connect-cli
    Preparing search index...

    Class FitConnectApiError

    Base class for every error originating from this client.

    Hierarchy (View Summary)

    Index
    • Parameters

      • args: {
            body: string;
            detail?: string;
            location?: string;
            maxRetryAfterMs?: number;
            method: string;
            retries?: number;
            retryAfterMs?: number;
            status: number;
            url: string;
        }

      Returns FitConnectApiError

    body: string
    cause?: unknown
    detail: string | undefined
    location: string | undefined

    For a redirect (301, 302, 303, 307, 308, or a 300 that names one), the Location target: absolute, userinfo redacted, control and bidi characters dropped. The client does not follow redirects, so this is where the server pointed — usually what to fix in baseUrl. Undefined otherwise.

    message: string
    method: string
    name: string
    retries: number

    How many times the engine retried the request before giving up (0 when it did not).

    retryAfterMs: number | undefined

    The wait the server asked for in Retry-After / RateLimit-Reset (milliseconds) when it was longer than the engine waits (MAX_RETRY_AFTER_MS), so the request was not retried; else undefined.

    stack?: string
    status: number
    url: string

    The request URL, absolute, with any userinfo redacted (https://***@host/…).

    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