Class HTTPClient<T>

Type Parameters

T extends Context

Hierarchy (view full)

Stack<T>
- HTTPClient

Index

Constructors

Properties

baseURI defaultWare length options

Methods

delete download execute get head mount patch post put request use

Constructors

constructor

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

Properties

baseURI

baseURI: string

defaultWare

defaultWare: Middleware<T> = ...

length

length: number = 0

options

options: RequestOptions

Methods

delete

delete<B>(path, body?, headers?): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optional body: any
- Optional headers: HeadersInit
Returns Promise<Response<B>>
- Defined in HTTPClient.ts:144

download

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

execute

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

get

get<B>(path, headers?): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optional headers: HeadersInit
Returns Promise<Response<B>>
- Defined in HTTPClient.ts:101

head

head(path, headers?): Promise<Record<string, string | object>>
Parameters
- path: string | URL
- Optional headers: HeadersInit
Returns Promise<Record<string, string | object>>
- Defined in HTTPClient.ts:92

mount

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

patch

patch<B>(path, body?, headers?): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optional body: any
- Optional headers: HeadersInit
Returns Promise<Response<B>>
- Defined in HTTPClient.ts:131

post

post<B>(path, body?, headers?): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optional body: any
- Optional headers: HeadersInit
Returns Promise<Response<B>>
- Defined in HTTPClient.ts:105

put

put<B>(path, body?, headers?): Promise<Response<B>>
Type Parameters
- B
Parameters
- path: string | URL
- Optional body: any
- Optional headers: HeadersInit
Returns Promise<Response<B>>
- Defined in HTTPClient.ts:118

request

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

use

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

Generated using TypeDoc