Client

Index

Interfaces

• Options

Variables

• defaultTimeoutDuration

Functions

• getRequestTimeoutDuration
• getTimeoutDuration

Interfaces

Options

Options:

optionalfetch

fetch?: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response> }

Inherited from Partial.fetch

Fetch function. Default to globalThis.fetch.

optionalonRequest

onRequest?: (request: Request) => TaskLike<Request, HTTPError>

Inherited from Partial.onRequest

Wrap a request before sent

optionalonResponse

onResponse?: (response: Response<BodyReader>) => TaskLike<Response<BodyReader>, HTTPError>

Inherited from Partial.onResponse

Wrap a received response

optionaltimeout

timeout?: default | none | TimeDuration

Inherited from Partial.timeout

Response timeout setting

Variables

constdefaultTimeoutDuration

defaultTimeoutDuration: TimeDuration = ...

Functions

getRequestTimeoutDuration

• getRequestTimeoutDuration(client: Client, requestObject: Request): Option<TimeDuration>

• Returns the timeout duration in milliseconds for the request and client

  @example

  const client = Client();
  const duration = Client.getRequestTimeoutDuration(client);

getTimeoutDuration

• getTimeoutDuration(client: Client): Option<TimeDuration>

• Returns the timeout duration in milliseconds for client

  @example

  const client = Client();
  const duration = Client.getTimeoutDuration(client);