apis_shared.HttpClientOptions.md

QIWI SDK / Modules / apis/shared / HttpClientOptions

Interface: HttpClientOptions<Request, Response>

apis/shared.HttpClientOptions

Type parameters

Name	Type
Request	any
Response	any

Table of contents

Properties

• agent
• baseURL
• headers
• mapHttpErrors
• okStatusCodes
• parseResponse
• stringifyBody
• timeout

Properties

agent

• Optional agent: any

Defined in

apis/shared/http.types.ts:8

---

baseURL

• Optional baseURL: string

Defined in

apis/shared/http.types.ts:10

---

headers

• Optional headers: Readonly<Record<string, string>>

Defined in

apis/shared/http.types.ts:7

---

mapHttpErrors

• Optional mapHttpErrors: (error: HttpError<any, any>) => Error

Type declaration

▸ (error): Error

Parameters

Name	Type
error	HttpError<any, any>

Returns

Error

Defined in

apis/shared/http.types.ts:15

---

okStatusCodes

• Optional okStatusCodes: Collection<number>

Defined in

apis/shared/http.types.ts:9

---

parseResponse

• Optional parseResponse: (body: Uint8Array) => Response

Type declaration

▸ (body): Response

Parameters

Name	Type
body	Uint8Array

Returns

Response

Defined in

apis/shared/http.types.ts:14

---

stringifyBody

• Optional stringifyBody: (body: Request) => string | Uint8Array

Type declaration

▸ (body): string | Uint8Array

Parameters

Name	Type
body	Request

Returns

string | Uint8Array

Defined in

apis/shared/http.types.ts:13

---

timeout

• Optional timeout: number

Defined in

apis/shared/http.types.ts:11