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

    Class RequestEngine

    Index
    • Build a fully-qualified URL from a path and optional query parameters.

      Throws a FdsError for a path with a "." or ".." segment. The resource methods put ids into the path with encodeURIComponent, which leaves those two unchanged, and URL parsing then resolves them: requests.get(".") would request /api/v1/request/ (the list) and get("..") the API root. Neither can name a resource. (Percent-encoded forms such as "%2e%2e" are safe: encodeURIComponent turns their "%" into "%25".)

      Parameters

      Returns string

    • Perform a GET expecting JSON and parse it into T. With shape, the parsed value must have the documented form (responseShapeProblem), or the call throws an FdsParseError: a null, {}, {"detail": "Wartung"} or an array answered with a 2xx would otherwise be printed as data with exit 0, or read as "nothing found".

      Type Parameters

      • T

      Parameters

      Returns Promise<T>

    • Perform a GET returning the raw bytes (the server-rendered CSV). An HTML page (a maintenance or login page, a proxy's error page) or a JSON body answered with a 2xx to a CSV request is an FdsParseError, not a download: the CLI would otherwise print it, or save it over the user's -o file, with exit 0.

      Parameters

      • path: string
      • accept: string
      • Optionalquery: QueryParams

      Returns Promise<RawResponse>

    • Perform a request with Accept negotiation and transient-error retries. A query with a blank value (or blank parameter name) is rejected with an FdsValidationError before anything is sent: the API reads an empty parameter as "no filter" and would answer with the unfiltered dataset.

      Parameters

      • method: string
      • path: string
      • options: { accept: string; query?: QueryParams } = ...

      Returns Promise<RawResponse>