HttpClientConfig

A set of configuration options, which allows HttpClient to perform

Type parameters

▪ T

Hierarchy

• HttpClientConfig

Index

Properties

• baseUrl

• bodyParser

• bodySerializer

• defaultHeadersProvider

• queryParserOptions

• querySerializerOptions

• requestHandler

• requestTimeout

Properties

Optional baseUrl

• baseUrl? : undefined | string

Defined in packages/http/src/httpClient.ts:69

URL that is applied to all requests without specified protocol and domain.

Optional bodyParser

• bodyParser? : BodyParser‹T›

Defined in packages/http/src/httpClient.ts:57

A utility that parses and normalizes body of a response received from server. Can be used to decode JSON object, URL-encoded body or plain text. Built-in bodyParser supports case-conversion.

Optional bodySerializer

• bodySerializer? : BodySerializer

Defined in packages/http/src/httpClient.ts:64

A utility that parses and normalizes body of a request sent to server. Can be used to encode JSON object, URL-encoded body or plain text. Built-in bodySerializer supports case-conversion.

Optional defaultHeadersProvider

• defaultHeadersProvider? : HeadersProvider

Defined in packages/http/src/httpClient.ts:50

Old way of passing global headers to requests. To add headers dynamically, you can use an interceptor instead. To add a set of static headers, pass them to request handler options directly.

deprecated

Optional queryParserOptions

• queryParserOptions? : qs.IParseOptions

Defined in packages/http/src/httpClient.ts:74

Allow to parse query options in a different way than the standard one.

Optional querySerializerOptions

• querySerializerOptions? : qs.IStringifyOptions

Defined in packages/http/src/httpClient.ts:79

Allow to serialize query options in a different way than the standard one.

requestHandler

• requestHandler: HttpRequestHandler

Defined in packages/http/src/httpClient.ts:42

An implementation of request handler, which handles "low-level" HTTP communication. Result of executing a request via RequestHandler is a normalized object, which can be further processed by interceptors and HttpClient.

• For Node.js environment, use httpRequestHandler

• For browser environments, use fetchRequestHandler

• For React Native and any other environment, use xhrRequestHandler

Optional requestTimeout

• requestTimeout? : undefined | number

Defined in packages/http/src/httpClient.ts:86

Standard timeout, triggered when server does not respond with headers within specified period of time.

default DEFAULT_REQUEST_TIMEOUT_MS