@maschinenlesbar.org/destatis-genesis-cli
    Preparing search index...

    Class DestatisApiError

    The API signalled a failure. GENESIS-Online is unusual: it answers HTTP 200 for most logical errors and carries the real outcome in a Status object in the body (see engine.ts). This error therefore models both worlds:

    • httpStatus is set for genuine transport/HTTP failures (non-2xx, e.g. a gateway 502 or an auth-layer 401);
    • code is set for a GENESIS logical error, taken from Status.Code (e.g. 90 = object not found, 98 = table too large), with statusType the Status.Type ("Fehler"/"Error").

    At least one of the two is always present; detail holds the human-readable message (Status.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 DestatisApiError

    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 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. Lets the CLI map a 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