Class ApiClient

constructor

• new ApiClient(configuration?: ApiClientConfiguration): ApiClient

  Parameters

  • configuration: ApiClientConfiguration = ...

  Returns ApiClient

configuration

callWithOptions

• callWithOptions<T>(
      path: string,
      requestOptions: ApiRequest,
      fixup?: (value: T) => void,
  ): Future<T>

  Issue an HTTP request and return a Future that resolves with the parsed response body. fixup runs synchronously on the parsed body before the Future resolves (e.g. Type.fixupPrototype to restore class prototypes on plain JSON). Rejecting the returned Future (e.g. via CancelSignal.guard) aborts the in-flight request on the wire.

  Type Parameters

  • T

  Parameters

  • path: string
  • requestOptions: ApiRequest
  • Optionalfixup: (value: T) => void

  Returns Future<T>

callWithOptionsAndHeaders

• callWithOptionsAndHeaders<T, H>(
      path: string,
      requestOptions: ApiRequest,
      parseHeaders: (value: Headers) => H,
      fixup?: (value: T) => void,
  ): Future<ResponseWithHeaders<T, H>>

  Issue an HTTP request and return a Future that resolves with the parsed response body and headers. parseHeaders converts the response's global Headers into the typed header value H. fixup runs synchronously on the parsed body before the Future resolves, exactly as in callWithOptions.

  Type Parameters

  • T
  • H

  Parameters

  • path: string
  • requestOptions: ApiRequest
  • parseHeaders: (value: Headers) => H
  • Optionalfixup: (value: T) => void

  Returns Future<ResponseWithHeaders<T, H>>

callWithOptionsAndHeadersOnly

• callWithOptionsAndHeadersOnly<H>(
      path: string,
      requestOptions: ApiRequest,
      parseHeaders: (value: Headers) => H,
  ): Future<H>

  Issue an HTTP request and return a Future that resolves with just the response headers, converted by parseHeaders. For no-body (e.g. 204) operations that still carry typed response headers.

  Type Parameters

  • H

  Parameters

  • path: string
  • requestOptions: ApiRequest
  • parseHeaders: (value: Headers) => H

  Returns Future<H>

streamWithOptions

• streamWithOptions<T>(
      path: string,
      requestOptions: ApiRequest,
      fixup?: (value: T) => void,
  ): Promise<ServerSentEventsStream<T>>

  Open a Server-Sent Events stream. Returns a handle whose events async iterable yields each parsed event; abort ends the stream. On a clean server close the connection is transparently re-established (resuming from the last event id); 4xx (except 429) are fatal, 429/5xx are retried.

  Type Parameters

  • T

  Parameters

  • path: string
  • requestOptions: ApiRequest
  • Optionalfixup: (value: T) => void

  Returns Promise<ServerSentEventsStream<T>>