Class HTTPClient<T>

Type Parameters

T extends Context

Hierarchy (View Summary)

Stack<T>
- HTTPClient

Index

Constructors

Properties

baseRequest baseURI defaultWare length options

Methods

delete download execute get head mount patch post put request use

Constructors

constructor

new HTTPClient<T extends Context>(
__namedParameters?: ClientOptions,
): HTTPClient<T>
Type Parameters
- T extends Context
Parameters
- __namedParameters: ClientOptions = {}
Returns HTTPClient<T>
Overrides Stack.constructor
- Defined in source/HTTPClient.ts:45

Properties

baseRequest

baseRequest: <B>(__namedParameters: Request) => RequestResult<B>

baseURI

baseURI: string

defaultWare

defaultWare: Middleware<T> = ...

length

length: number = 0

options

options: RequestOptions

Methods

delete

delete<B>(
    path: string | URL,
    body?: any,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optionalbody: any
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:169

download

download(
path: string | URL,
__namedParameters?: DownloadOptions,
): AsyncGenerator<TransferProgress>
Parameters
- path: string | URL
- __namedParameters: DownloadOptions = {}
Returns AsyncGenerator<TransferProgress>
- Defined in source/HTTPClient.ts:184

execute

execute(context?: T, depth?: number): any
Parameters
- Optionalcontext: T
- depth: number = 0
Returns any
Inherited from Stack.execute
- Defined in source/Stack.ts:17

get

get<B>(
    path: string | URL,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:116

head

head(
    path: string | URL,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Record<string, string | object>>
Parameters
- path: string | URL
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Record<string, string | object>>
- Defined in source/HTTPClient.ts:102

mount

mount(condition: (context: T) => boolean, stack: Stack<T>): HTTPClient<T>
Parameters
- condition: (context: T) => boolean
- stack: Stack<T>
Returns HTTPClient<T>
Inherited from Stack.mount
- Defined in source/Stack.ts:27

patch

patch<B>(
    path: string | URL,
    body?: any,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optionalbody: any
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:154

post

post<B>(
    path: string | URL,
    body?: any,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optionalbody: any
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:124

put

put<B>(
    path: string | URL,
    body?: any,
    headers?: HeadersInit,
    options?: MethodOptions,
): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optionalbody: any
- Optionalheaders: HeadersInit
- Optionaloptions: MethodOptions
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:139

request

request<B>(data: T["request"]): Promise<Response<B>>
Type Parameters
- B
Parameters
- data: T["request"]
Returns Promise<Response<B>>
- Defined in source/HTTPClient.ts:91

use

use(...middlewares: Middleware<T>[]): HTTPClient<T>
Parameters
- ...middlewares: Middleware<T>[]
Returns HTTPClient<T>
Overrides Stack.use
- Defined in source/HTTPClient.ts:85