@maschinenlesbar.org/regionalstatistik-cli
    Preparing search index...

    Class RegionalstatistikApiError

    The API signalled a failure. GENESIS is unusual: it answers HTTP 200 for most logical errors and carries the real outcome in a Status object in the body — while authentication failures arrive as a bare { Code, Content, Type } object at the top level, on a non-2xx status (verified live: HTTP 401 with Code 15 for missing credentials, HTTP 404 with Code 2 for wrong credentials — see engine.ts). This error therefore models both worlds, together when needed:

    • httpStatus is set for transport/HTTP failures (non-2xx, e.g. a 405 on a GET to an authenticated endpoint or a gateway 502);
    • code is set for a GENESIS logical error, taken from Status.Code or the flat top-level Code (e.g. 90 = object not found, 98 = table too large, 15 = not authorized), with statusType the Type ("Fehler"/"ERROR").

    At least one of the two is always present, and both are when a non-2xx reply carried a GENESIS status body; detail holds the human-readable message (Status.Content / Content, or a parsed field from an HTTP error body).

    Hierarchy (View Summary)

    Index
    • Parameters

      • args: {
            body: string;
            code?: number;
            detail?: string;
            httpStatus?: number;
            method: string;
            statusType?: string;
            url: string;
        }

      Returns RegionalstatistikApiError

    body: string
    cause?: unknown
    code: number | undefined
    detail: string | undefined
    httpStatus: number | undefined
    message: string
    method: string
    name: string
    stack?: string
    statusType: string | undefined
    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.

    • get isAuthError(): boolean

      True when the API rejected the credentials: the GENESIS logical code 15 ("Sie sind nicht berechtigt ..." — no/unrecognized credentials) or a transport-level 401/403. The CLI appends a credentials hint for these.

      Returns boolean

    • get isNotFound(): boolean

      True when the API signalled "no such object": the GENESIS logical code 90 (requested object not found), or a transport-level HTTP 404 that did NOT carry a contradicting GENESIS code in its body — the live server answers wrong credentials with HTTP 404 + { Code: 2, ... }, which is an auth problem, not a missing object. Lets the CLI map a genuine miss to a distinct exit code for scripting.

      Returns boolean

    • get isRetryable(): boolean

      True for HTTP statuses the engine treats as transient and retries.

      Returns boolean

    • 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