Client

Index

Interfaces

• Options

Variables

• defaultTimeoutDuration

Functions

• getRequestTimeoutDuration
• getTimeoutDuration

Interfaces

Options

Options:

optionalinheritedfetch

fetch?: { (input, init): Promise<Response>; (input, init): Promise<Response> }

Inherited from Partial.fetch

Fetch function. Default to globalThis.fetch.

optionalinheritedonRequest

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

Inherited from Partial.onRequest

Wrap a request before sent

optionalinheritedonResponse

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

Inherited from Partial.onResponse

Wrap a received response

optionalinheritedtimeout

timeout?: any

Inherited from Partial.timeout

Response timeout setting

Variables

defaultTimeoutDuration

defaultTimeoutDuration: TimeDuration = ...

Default timeout duration in milliseconds for client

Functions

getRequestTimeoutDuration

• getRequestTimeoutDuration(client, requestObject): 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): Option<TimeDuration>

• Returns the timeout duration in milliseconds for client

  @example

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