Interface Client

interface Client {
    binaryProvider?: (<Req>(requestOptions: ClientRequest<Req>) => Promise<ClientResponse<Buffer>>);
    provider<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>>;
}

Methods

provider

Properties

OptionalbinaryProvider

binaryProvider?: (<Req>(requestOptions: ClientRequest<Req>) => Promise<ClientResponse<Buffer>>)

Sends a request to the specified URL with the given options, that returns a binary response

Param: requestOptions

The options for the request.

Param: requestOptions.url

The URL to send the request to.

Param: requestOptions.method

The HTTP method to use, either "GET" or "POST".

Param: requestOptions.path

An optional path to append to the URL.

Param: requestOptions.body

The body of the request, applicable for POST requests.

Param: requestOptions.contentType

The content type of the request body.

Param: requestOptions.acceptType

The expected content type of the response.

Param: requestOptions.params

Optional parameters to include in the request.

Param: requestOptions.originMethod

An optional method to specify the origin of the request.

Param: requestOptions.overrides

Optional configuration overrides for the request.

Settings

Member Visibility

On This Page

Methods
Properties
MMNEPVFCICPMFPCPTTAAATR