Class NodeHTTP2Client

An implementation for HTTPClient that uses the node http package

Implements

Index

Methods

close isClosed request stream getClient

Methods

close

close(): void
Flags the calling Client as no longer referencing this HTTPClient. Once no Client instances reference this HTTPClient the underlying resources will be closed. It is expected that calls to this method are only made by a Client instantiation. The behavior of direct calls is undefined.

Returns void
Remarks
For some HTTPClients, such as the FetchClient, this method is a no-op as there is no shared resource to close.
Implementation of HTTPClient.close
- Defined in src/http-client/node-http2-client.ts:123

isClosed

isClosed(): boolean
Returns boolean
true if this client has been closed, false otherwise.
- Defined in src/http-client/node-http2-client.ts:137

request

request<T>(req): Promise<HTTPResponse>
Makes an HTTP request and returns the response
Type Parameters
- T = QueryRequest<string | QueryInterpolation>
Parameters
- req: HTTPRequest<T>
  an HTTPRequest
Returns Promise<HTTPResponse>
A Promise<HTTPResponse>
Implementation of HTTPClient.request
- Defined in src/http-client/node-http2-client.ts:81

stream

stream(req): StreamAdapter
Makes an HTTP request and returns the response
Parameters
- req: HTTPStreamRequest
  an HTTPStreamRequest
Returns StreamAdapter
A Promise<HTTPResponse>
Implementation of HTTPStreamClient.stream
- Defined in src/http-client/node-http2-client.ts:118

`Static`getClient

getClient(httpClientOptions): NodeHTTP2Client
Gets a NodeHTTP2Client matching the HTTPClientOptions
Parameters
- httpClientOptions: HTTPClientOptions
  the HTTPClientOptions
Returns NodeHTTP2Client
a NodeHTTP2Client matching the HTTPClientOptions
- Defined in src/http-client/node-http2-client.ts:62