Class HttpClient

Implements

IHttpClient

Index

Constructors

constructor

new HttpClient(
DefaultRequestHeaders?: Record<string, string>,
fetchRef?: Fetch,
): 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.

`Protected`fetchRef

fetchRef: Fetch = ...

`Optional`OnRequestReceived

OnRequestReceived?: (request: 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: Request): Promise<Request | Response>
- Parameters
  - request: Request
    the original request
  Returns Promise<Request | Response>
  a modified request or a response

`Optional`OnResponseResolved

OnResponseResolved?: (response: Response) => void

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

Methods

Delete

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

Get

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

Patch

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

Post

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

Put

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

Request

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

Class HttpClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HttpClient

Properties

DefaultRequestHeaders

ProtectedfetchRef

OptionalOnRequestReceived

Type Declaration

Parameters

Returns Promise<Request | Response>

OptionalOnResponseResolved

Methods

Delete

Type Parameters

Parameters

Returns Promise<RestResponse<T>>

Get

Type Parameters

Parameters

Returns Promise<RestResponse<T>>

Patch

Type Parameters

Parameters

Returns Promise<RestResponse<T>>

Post

Type Parameters

Parameters

Returns Promise<RestResponse<T>>

Put

Type Parameters

Parameters

Returns Promise<RestResponse<T>>

Request

Parameters

Returns Promise<Response>

Settings

On This Page

`Protected`fetchRef

`Optional`OnRequestReceived

`Optional`OnResponseResolved