Skip to main content

Type Alias: ResponseMode

ResponseMode = "envelope" | "empty" | "raw" | "prometheus" | "redirect"

Defined in: src/transport.ts:18

How a successful response is read (classified by the generator from the spec):

  • envelope: {status, data} → returns data;
  • empty: 204 or a 2xx with no declared body → undefined;
  • raw: a streamed file (CSV/NDJSON) → Response;
  • prometheus: {status, data, warnings, infos} → the whole object;
  • redirect: SSO callbacks (303) → Response, without following the redirect.