Class: HttpAdapter

http.HttpAdapter

Adapter implementation for HTTP interaction using fetch.

Implements

• AdapterI<Response>

Constructors

constructor

• new HttpAdapter(config?)

Parameters

Name	Type
config?	HttpAdapterConfig

Defined in

src/http/httpAdapter.ts:56

Properties

appendParams

• Private appendParams: null | ParamsAppender = null

Defined in

src/http/httpAdapter.ts:44

---

baseURL

• Private baseURL: null | string = null

Defined in

src/http/httpAdapter.ts:38

---

defaultBodyAs

• Private defaultBodyAs: null | BodyAsTransformer = null

Defined in

src/http/httpAdapter.ts:48

---

defaultHeaders

• Private defaultHeaders: Dictionary<string> = {}

Defined in

src/http/httpAdapter.ts:46

---

errorTransformers

• Private errorTransformers: ErrorTransformer[] = []

Defined in

src/http/httpAdapter.ts:54

---

fetch

• Private fetch: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response> = globalThis.fetch

Type declaration

▸ (input, init?): Promise<Response>

MDN Reference

Parameters

Name	Type
input	RequestInfo | URL
init?	RequestInit

Returns

Promise<Response>

Defined in

src/http/httpAdapter.ts:40

---

requestTransformers

• Private requestTransformers: RequestTransformer[] = []

Defined in

src/http/httpAdapter.ts:50

---

responseTransformers

• Private responseTransformers: ResponseTransformer[] = []

Defined in

src/http/httpAdapter.ts:52

---

serializeParams

• Private serializeParams: HttpParamsSerializer = paramsSerializer

Defined in

src/http/httpAdapter.ts:42

Methods

clearRequestURLEndpoint

▸ Protected clearRequestURLEndpoint(endpoint): string

Parameters

Name	Type
endpoint	string

Returns

string

Defined in

src/http/httpAdapter.ts:178

---

configure

▸ configure(config?, override?): void

Parameters

Name	Type	Default value
config?	HttpAdapterConfig	undefined
override	boolean	true

Returns

void

Defined in

src/http/httpAdapter.ts:60

---

execute

▸ execute(context): Promise<Response>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<Response>

Inherit Doc

Implementation of

AdapterI.execute

Defined in

src/http/httpAdapter.ts:67

---

isNotFound

▸ isNotFound(error): boolean

Parameters

Name	Type
error	unknown

Returns

boolean

Inherit Doc

Implementation of

AdapterI.isNotFound

Defined in

src/http/httpAdapter.ts:93

---

makeRequest

▸ Protected makeRequest(context): Promise<HttpRequest>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<HttpRequest>

Defined in

src/http/httpAdapter.ts:97

---

makeRequestError

▸ Protected makeRequestError(request, error): Promise<unknown>

Parameters

Name	Type
request	HttpRequest
error	unknown

Returns

Promise<unknown>

Defined in

src/http/httpAdapter.ts:224

---

makeRequestInit

▸ Protected makeRequestInit(context): Promise<HttpRequestInit>

Create the request init object from the given context. May also affect the headers and body.

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<HttpRequestInit>

Defined in

src/http/httpAdapter.ts:118

---

makeRequestMethod

▸ Protected makeRequestMethod(context): Promise<HttpMethod>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<HttpMethod>

Defined in

src/http/httpAdapter.ts:143

---

makeRequestURL

▸ Protected makeRequestURL(context): Promise<string>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<string>

Defined in

src/http/httpAdapter.ts:105

---

makeRequestURLAdditionalParams

▸ Protected makeRequestURLAdditionalParams(context): Promise<undefined | string>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<undefined | string>

Defined in

src/http/httpAdapter.ts:189

---

makeRequestURLContextParams

▸ Protected makeRequestURLContextParams(context): Promise<undefined | string>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<undefined | string>

Defined in

src/http/httpAdapter.ts:197

---

makeRequestURLEndpoint

▸ Protected makeRequestURLEndpoint(context): Promise<string>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<string>

Defined in

src/http/httpAdapter.ts:162

---

makeRequestURLParams

▸ Protected makeRequestURLParams(context): Promise<string>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Promise<string>

Defined in

src/http/httpAdapter.ts:182

---

makeRequestURLParamsFromObject

▸ Protected makeRequestURLParamsFromObject(params): undefined | string

Parameters

Name	Type
params	Dictionary

Returns

undefined | string

Defined in

src/http/httpAdapter.ts:213

---

makeRequestURLParamsFromString

▸ Protected makeRequestURLParamsFromString(params): string

Parameters

Name	Type
params	string

Returns

string

Defined in

src/http/httpAdapter.ts:209

---

makeResponseError

▸ Protected makeResponseError(request, response): Promise<unknown>

Parameters

Name	Type
request	HttpRequest
response	Response

Returns

Promise<unknown>

Defined in

src/http/httpAdapter.ts:236

---

runRequest

▸ Protected runRequest(request): Promise<Response>

Parameters

Name	Type
request	HttpRequest

Returns

Promise<Response>

Defined in

src/http/httpAdapter.ts:217

---

transformError

▸ Protected transformError(context, error): Promise<unknown>

Parameters

Name	Type
context	HttpRequestConfig
error	unknown

Returns

Promise<unknown>

Defined in

src/http/httpAdapter.ts:269

---

transformRequest

▸ Protected transformRequest(context, request): Promise<HttpRequest>

Parameters

Name	Type
context	HttpRequestConfig
request	HttpRequest

Returns

Promise<HttpRequest>

Defined in

src/http/httpAdapter.ts:255

---

transformResponse

▸ Protected transformResponse(context, response): Promise<Response>

Parameters

Name	Type
context	HttpRequestConfig
response	Response

Returns

Promise<Response>

Defined in

src/http/httpAdapter.ts:262