tsbase
    Preparing search index...

    Interface IHttpClient

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

    Implemented by

    Index

    Properties

    DefaultRequestHeaders OnRequestReceived? OnResponseResolved?

    Methods

    Delete Get Patch Post Put Request

    Properties

    DefaultRequestHeaders: Record<string, string>

    Gets the headers which should be sent with each request.

    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

    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

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

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

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

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

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

    • Parameters

      • uri: string
      • method: HttpMethod
      • Optionalbody: string
      • OptionaladditionalHeaders: Record<string, string>

      Returns Promise<Response>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods