Class CurlHttpClient

Curl HTTP client implementation

Implements

HttpClient

Constructors

constructor

new CurlHttpClient(
config: Config<CurlHttpClientConfig>,
logger: Logger,
): CurlHttpClient
Parameters
- config: Config<CurlHttpClientConfig>
- logger: Logger
Returns CurlHttpClient
- Defined in packages/http-client/src/curl-http-client.ts:39

Methods

simple

simple(
    proxy: string,
    method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
    url: string,
    requestHeaders: HttpHeaders,
    requestBody: HttpBody,
    connectTimeout: number,
    timeout: number,
    headersSizeLimit: number,
    bodySizeLimit: number,
): Promise<HttpClientSimpleResult | HttpClientErrorResult>
Simple HTTP request and response
Parameters
- proxy: string
- method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
- url: string
- requestHeaders: HttpHeaders
- requestBody: HttpBody
- connectTimeout: number
- timeout: number
- headersSizeLimit: number
- bodySizeLimit: number
Returns Promise<HttpClientSimpleResult | HttpClientErrorResult>
Implementation of HttpClient.simple
- Defined in packages/http-client/src/curl-http-client.ts:48

streamRequest

streamRequest(
    proxy: string,
    method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
    url: string,
    requestHeaders: HttpHeaders,
    requestStream: Readable,
    connectTimeout: number,
    timeout: number,
    headersSizeLimit: number,
    bodySizeLimit: number,
): Promise<HttpClientSimpleResult | HttpClientErrorResult>
Streaming HTTP request and simple response
Parameters
- proxy: string
- method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
- url: string
- requestHeaders: HttpHeaders
- requestStream: Readable
- connectTimeout: number
- timeout: number
- headersSizeLimit: number
- bodySizeLimit: number
Returns Promise<HttpClientSimpleResult | HttpClientErrorResult>
Implementation of HttpClient.streamRequest
- Defined in packages/http-client/src/curl-http-client.ts:93

streamResponse

streamResponse(
    proxy: string,
    method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS",
    url: string,
    requestHeaders: HttpHeaders,
    requestBody: HttpBody,
    connectTimeout: number,
    timeout: number,
    headersSizeLimit: number,
): Promise<HttpClientErrorResult | HttpClientStreamResult>
Simple HTTP request and streaming response
Parameters
- proxy: string
- method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS"
- url: string
- requestHeaders: HttpHeaders
- requestBody: HttpBody
- connectTimeout: number
- timeout: number
- headersSizeLimit: number
Returns Promise<HttpClientErrorResult | HttpClientStreamResult>
Implementation of HttpClient.streamResponse
- Defined in packages/http-client/src/curl-http-client.ts:138

`Static`register

register(container: DIContainer): void
Register dependency
Parameters
- container: DIContainer
Returns void
- Defined in packages/http-client/src/curl-http-client.ts:30