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

    Class OparlApiError

    The server responded with a non-2xx HTTP status (or a redirect this client does not follow). detail holds a short, sanitised snippet of the response body when a useful textual one is present. For a 3xx that was not followed (not a followable status, no Location, or past maxRedirects), location holds the redirect target (absolute, sanitised, without userinfo) and the message names it; after the redirect limit it also says how many redirects were followed, so a loop reads as one.

    Hierarchy (View Summary)

    Index
    • Parameters

      • args: {
            body: string;
            credentialsDropped?: { from: string; to: string };
            detail?: string;
            location?: string;
            method: string;
            redirectsFollowed?: number;
            status: number;
            url: string;
        }
        • body: string
        • OptionalcredentialsDropped?: { from: string; to: string }

          Set when a redirect to another origin dropped the credential headers.

        • Optionaldetail?: string
        • Optionallocation?: string
        • method: string
        • OptionalredirectsFollowed?: number

          Set when the redirect limit stopped the request: the redirects followed.

        • status: number
        • url: string

      Returns OparlApiError

    body: string
    cause?: unknown
    credentialsDropped: { from: string; to: string } | undefined

    Set when a redirect led to another origin (in OParl, only an http→https upgrade on the same host), so the credential headers of defaultHeaders were not sent to the server that answered. A 401/403 then says nothing about them; the message says what happened.

    detail: string | undefined
    location: string | undefined
    message: string
    method: string
    name: string

    Set when a list walk failed on page 2 or later: the walk up to that point — the objects of the pages fetched before the failure, next set to the URL of the page that failed, and a note saying so. The CLI prints it before the error.

    stack?: string
    status: number
    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.

    • 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