Interface IHttpClient

interface IHttpClient {
    DefaultRequestHeaders: Record<string, string>;
    OnRequestReceived?: ((request) => Promise<Request | Response>);
    OnResponseResolved?: ((response) => void);
    Delete<T>(uri, additionalHeaders?): Promise<RestResponse<T>>;
    Get<T>(uri, additionalHeaders?): Promise<RestResponse<T>>;
    Patch<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>;
    Post<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>;
    Put<T>(uri, body?, additionalHeaders?): Promise<RestResponse<T>>;
    Request(uri, method, body?, additionalHeaders?): Promise<Response>;
}

Implemented by

Properties

DefaultRequestHeaders OnRequestReceived? OnResponseResolved?

Methods

Delete Get Patch Post Put Request

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>

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

      Parameters

      • request: Request

        the original request

      Returns Promise<Request | Response>

      a modified request or a 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

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

      Parameters

      • response: Response

      Returns void

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>>

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>>

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>>

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>>

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>>

Request

  • Request(uri, method, body?, additionalHeaders?): Promise<Response>

  • Parameters

    • uri: string
    • method: HttpMethod
    • Optional body: string
    • Optional additionalHeaders: Record<string, string>

    Returns Promise<Response>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc