Class HttpClient

Implements

IHttpClient

Index

Constructors

constructor

new HttpClient(DefaultRequestHeaders?, fetchRef?): HttpClient
Parameters
- DefaultRequestHeaders: Record<string, string> = {}
- fetchRef: Fetch = ...
Returns HttpClient
- Defined in src/Net/Http/HttpClient.ts:10

Properties

DefaultRequestHeaders

DefaultRequestHeaders: Record<string, string> = {}

Gets the headers which should be sent with each request.

`Optional` OnRequestReceived

OnRequestReceived?: ((request) => Promise<Request | Response>)

An operation used to modify a request prior to submission OR override the normal request process and return a response.

Type declaration

- (request): Promise<Request | Response>
- Parameters
  - request: Request
  Returns Promise<Request | Response>

Param: request

the original request

Returns

a modified request or a response

`Optional` OnResponseResolved

OnResponseResolved?: ((response) => void)

An operation to be performed just after a response is resolved from a request, but prior to the response being returned.

Type declaration

- (response): void
- Parameters
  - response: Response
  Returns void

`Protected` fetchRef

fetchRef: Fetch = ...

Methods

Delete

Delete<T>(uri, additionalHeaders?): Promise<RestResponse<T>>
Send a DELETE request to the specified Uri as an asynchronous operation.
Type Parameters
- T
Parameters
- uri: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
Implementation of IHttpClient.Delete
- Defined in src/Net/Http/HttpClient.ts:53

Get

Get<T>(uri, additionalHeaders?): Promise<RestResponse<T>>
Send a GET request to the specified Uri as an asynchronous operation.
Type Parameters
- T
Parameters
- uri: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
Implementation of IHttpClient.Get
- Defined in src/Net/Http/HttpClient.ts:37

Patch

Patch<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>
Send a PATCH request to the specified Uri as an asynchronous operation.
Type Parameters
- T
Parameters
- uri: string
- Optional body: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
Implementation of IHttpClient.Patch
- Defined in src/Net/Http/HttpClient.ts:41

Post

Post<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>
Send a POST request to the specified Uri as an asynchronous operation.
Type Parameters
- T
Parameters
- uri: string
- Optional body: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
Implementation of IHttpClient.Post
- Defined in src/Net/Http/HttpClient.ts:45

Put

Put<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>
Send a PUT request to the specified Uri as an asynchronous operation.
Type Parameters
- T
Parameters
- uri: string
- Optional body: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
Implementation of IHttpClient.Put
- Defined in src/Net/Http/HttpClient.ts:49

Request

Request(uri, method, body?, additionalHeaders?): Promise<Response>
Parameters
- uri: string
- method: HttpMethod
- Optional body: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<Response>
Implementation of IHttpClient.Request
- Defined in src/Net/Http/HttpClient.ts:15

`Private` getRestResponse

getRestResponse<T>(uri, method, body?, additionalHeaders?): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- uri: string
- method: HttpMethod
- Optional body: string
- Optional additionalHeaders: Record<string, string>
Returns Promise<RestResponse<T>>
- Defined in src/Net/Http/HttpClient.ts:57

Class HttpClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

DefaultRequestHeaders: Record<string, string> = {}

fetchRef: Fetch = ...

Returns HttpClient

Properties

DefaultRequestHeaders

Optional OnRequestReceived

Type declaration

Parameters

request: Request

Returns Promise<Request | Response>

Param: request

Returns

Optional OnResponseResolved

Type declaration

Parameters

response: Response

Returns void

Protected fetchRef

Methods

Delete

Type Parameters

T

Parameters

uri: string

Optional additionalHeaders: Record<string, string>

Returns Promise<RestResponse<T>>

Get

Type Parameters

T

Parameters

uri: string

Optional additionalHeaders: Record<string, string>

Returns Promise<RestResponse<T>>

Patch

Type Parameters

T

Parameters

uri: string

Optional body: string

Optional additionalHeaders: Record<string, string>

Returns Promise<RestResponse<T>>

Post

Type Parameters

T

Parameters

uri: string

Optional body: string

Optional additionalHeaders: Record<string, string>

Returns Promise<RestResponse<T>>

Put

Type Parameters

T

Parameters

uri: string

Optional body: string

Optional additionalHeaders: Record<string, string>

Returns Promise<RestResponse<T>>

Request

Parameters

uri: string

method: HttpMethod

Optional body: string

Optional additionalHeaders: Record<string, string>

Returns Promise<Response>

Private getRestResponse

Type Parameters

T

Parameters

uri: string

method: HttpMethod

Optional body: string

`Optional` OnRequestReceived

`Optional` OnResponseResolved

`Protected` fetchRef

`Optional` additionalHeaders: Record<string, string>

`Optional` additionalHeaders: Record<string, string>

`Optional` body: string

`Optional` additionalHeaders: Record<string, string>

`Optional` body: string

`Optional` additionalHeaders: Record<string, string>

`Optional` body: string

`Optional` additionalHeaders: Record<string, string>

`Optional` body: string

`Optional` additionalHeaders: Record<string, string>

`Private` getRestResponse

`Optional` body: string

`Optional` additionalHeaders: Record<string, string>