Module: http

Namespaces

• abortSignal
• makeDelete
• makeGet
• makePatch
• makePost
• makePut
• makeRequest
• param

Classes

• AbortedError
• ConflictError
• ForbiddenError
• HttpAdapter
• HttpAdapterError
• InterruptedError
• InvalidRequestError
• NotFoundError
• ResponseError
• ServerError
• TooManyRequestsError
• UnauthorizedError

Enhancers

abortSignal

▸ abortSignal(controllerOrSignal?): <C>(action: Action<C>) => Promise<Action<Awaited<C> & { signal: Optional<AbortSignal> }, {}>>

Configure an abort signal on the request to make it abortable.

Parameters

Name	Type
controllerOrSignal?	Optional<AbortController | AbortSignal>

Returns

fn

▸ <C>(action): Promise<Action<Awaited<C> & { signal: Optional<AbortSignal> }, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Awaited<C> & { signal: Optional<AbortSignal> }, {}>>

Defined in

src/http/actions/context/enhancers/abortSignal.ts:12

---

makeDelete

▸ makeDelete(pathOrBaseURL, body?, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

HTTP DELETE method shortcut for the makeRequest function.

Parameters

Name	Type
pathOrBaseURL	string
body?	unknown
config?	Omit<HttpRequestConfig, "body" | "method">

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makeDelete.ts:14

---

makeGet

▸ makeGet(pathOrBaseURL, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

HTTP GET method shortcut for the makeRequest function.

Parameters

Name	Type
pathOrBaseURL	string
config?	Omit<HttpRequestConfig, "body" | "method">

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makeGet.ts:13

---

makePatch

▸ makePatch(pathOrBaseURL, body?, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

HTTP PATCH method shortcut for the makeRequest function.

Parameters

Name	Type
pathOrBaseURL	string
body?	unknown
config?	Omit<HttpRequestConfig, "body" | "method">

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makePatch.ts:14

---

makePost

▸ makePost(pathOrBaseURL, body?, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

HTTP POST method shortcut for the makeRequest function.

Parameters

Name	Type
pathOrBaseURL	string
body?	unknown
config?	Omit<HttpRequestConfig, "body" | "method">

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makePost.ts:14

---

makePut

▸ makePut(pathOrBaseURL, body?, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

HTTP PUT method shortcut for the makeRequest function.

Parameters

Name	Type
pathOrBaseURL	string
body?	unknown
config?	Omit<HttpRequestConfig, "body" | "method">

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makePut.ts:14

---

makeRequest

▸ makeRequest(pathOrBaseURL, config?): <C>(action: Action<C>) => Promise<Action<Object, {}>>

Prepare a generic HTTP request. If given path starts with scheme (HTTPS, etc.), it will be used as the base URL of action, otherwise it will only be used as path.

Parameters

Name	Type
pathOrBaseURL	string
config?	HttpRequestConfig

Returns

fn

▸ <C>(action): Promise<Action<Object, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Object, {}>>

Defined in

src/http/actions/context/enhancers/makeRequest.ts:22

---

param

▸ param(key, value?): <C>(action: Action<C>) => Promise<Action<Awaited<C> & { params: {} }, {}>>

Set the given query param on the request. The new params will be merged with the previous ones.

Parameters

Name	Type
key	string | Dictionary
value?	unknown

Returns

fn

▸ <C>(action): Promise<Action<Awaited<C> & { params: {} }, {}>>

Type parameters

Name	Type
C	extends Object

Parameters

Name	Type
action	Action<C>

Returns

Promise<Action<Awaited<C> & { params: {} }, {}>>

Defined in

src/http/actions/context/enhancers/param.ts:14

Other

BodyAsTransformer

Ƭ BodyAsTransformer: (body: unknown, headers: Dictionary<string>) => Awaitable<BodyInit>

Type declaration

▸ (body, headers): Awaitable<BodyInit>

Parameters

Name	Type
body	unknown
headers	Dictionary<string>

Returns

Awaitable<BodyInit>

Defined in

src/http/types.ts:69

---

ErrorTransformer

Ƭ ErrorTransformer: (error: unknown) => Awaitable<unknown>

Type declaration

▸ (error): Awaitable<unknown>

Parameters

Name	Type
error	unknown

Returns

Awaitable<unknown>

Defined in

src/http/types.ts:68

---

HttpAdapterConfig

Ƭ HttpAdapterConfig: Object

The configuration for the HTTP adapter implementation.

Type declaration

Name	Type
appendParams?	ParamsAppender | null
baseURL?	string | null
defaultBodyAs?	BodyAsTransformer | null
defaultHeaders?	Dictionary<string>
errorTransformers?	ErrorTransformer[]
fetch?	typeof __type
requestTransformers?	RequestTransformer[]
responseTransformers?	ResponseTransformer[]
serializeParams?	HttpParamsSerializer

Defined in

src/http/types.ts:39

---

HttpMethod

Ƭ HttpMethod: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH" | "purge" | "PURGE" | "link" | "LINK" | "unlink" | "UNLINK"

The HTTP method to use in request.

Defined in

src/http/types.ts:6

---

HttpParamsSerializer

Ƭ HttpParamsSerializer: (params: Dictionary) => string | undefined

Type declaration

▸ (params): string | undefined

Parameters

Name	Type
params	Dictionary

Returns

string | undefined

Defined in

src/http/types.ts:51

---

HttpRequest

Ƭ HttpRequest: Object

Type declaration

Name	Type
context	HttpRequestConfig
init	HttpRequestInit
url	string

Defined in

src/http/types.ts:60

---

HttpRequestConfig

Ƭ HttpRequestConfig: Object

The configuration object for a request which is used as an action's context when using HttpAdapter.

Type declaration

Name	Type
baseURL?	string
body?	unknown
bodyAs?	BodyAsTransformer
errorTransformers?	ErrorTransformer[]
headers?	Dictionary<string>
method?	HttpMethod
params?	Dictionary<any> | string
path?	string
requestTransformers?	RequestTransformer[]
responseTransformers?	ResponseTransformer[]
signal?	AbortSignal | null

Defined in

src/http/types.ts:22

---

HttpRequestInit

Ƭ HttpRequestInit: Object

Type declaration

Name	Type
body	BodyInit
headers	Dictionary<string>
method	HttpMethod
signal?	AbortSignal | null

Defined in

src/http/types.ts:53

---

ParamsAppender

Ƭ ParamsAppender: (context: HttpRequestConfig) => Awaitable<Dictionary>

Type declaration

▸ (context): Awaitable<Dictionary>

Parameters

Name	Type
context	HttpRequestConfig

Returns

Awaitable<Dictionary>

Defined in

src/http/types.ts:70

---

RequestTransformer

Ƭ RequestTransformer: (request: HttpRequest) => Awaitable<HttpRequest>

Type declaration

▸ (request): Awaitable<HttpRequest>

Parameters

Name	Type
request	HttpRequest

Returns

Awaitable<HttpRequest>

Defined in

src/http/types.ts:66

---

ResponseTransformer

Ƭ ResponseTransformer: (response: Response) => Awaitable<Response>

Type declaration

▸ (response): Awaitable<Response>

Parameters

Name	Type
response	Response

Returns

Awaitable<Response>

Defined in

src/http/types.ts:67

---

appendIncludeParams

▸ appendIncludeParams(context, params, key, transform): Promise<Dictionary>

Parameters

Name	Type
context	Object
params	Dictionary
key	string
transform	(include: string[]) => any

Returns

Promise<Dictionary>

Defined in

src/http/utilities/appendIncludeParams.ts:4

---

bodyAsJson

▸ bodyAsJson(body): string

Parameters

Name	Type
body	any

Returns

string

Defined in

src/http/utilities/bodyAsJson.ts:1

---

deepParamsSerializer

▸ deepParamsSerializer(params): undefined | string

Parameters

Name	Type
params	Dictionary<any>

Returns

undefined | string

Defined in

src/http/utilities/deepParamsSerializer.ts:3

---

paramsSerializer

▸ paramsSerializer(params): undefined | string

Parameters

Name	Type
params	Dictionary<any>

Returns

undefined | string

Defined in

src/http/utilities/paramsSerializer.ts:3