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

    Class MastrApiError

    The API signalled a failure. MaStR is unusual: it answers HTTP 200 even when a request logically failed, carrying the message in the envelope's Errors field (e.g. "Die Anfrage ist Null."). This error models both worlds:

    • status is set for a genuine transport/HTTP failure (non-2xx);
    • otherwise it is a logical error taken from the response Errors string. detail holds the human-readable message in either case.

    Hierarchy (View Summary)

    Index
    • Parameters

      • args: { body: string; detail?: string; method: string; status?: number; url: string }

      Returns MastrApiError

    body: string
    cause?: unknown
    detail: string | undefined
    message: string
    method: string
    name: string
    stack?: string
    status: number | 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 isRetryable(): boolean

      True for HTTP statuses the API treats as transient and retry-able.

      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