Interface IHttpClient

Abstraction for HTTP client Follows Dependency Inversion Principle - depend on abstractions, not concretions

interface IHttpClient {
    download(
        url: string,
        options?: DownloadOptions,
    ): Promise<Buffer<ArrayBufferLike>>;
    request<T>(config: HttpRequestConfig): Promise<T>;
    upload<T>(config: UploadConfig): Promise<T>;
}

Index

Methods

download request upload

Methods

download

download(
url: string,
options?: DownloadOptions,
): Promise<Buffer<ArrayBufferLike>>
Download a file as a Buffer. Query parameters always go in options.params; there is no positional params overload.
Parameters
- url: string
- Optionaloptions: DownloadOptions
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in core/http-client.interface.ts:62

request

request<T>(config: HttpRequestConfig): Promise<T>
Make an HTTP request
Type Parameters
- T
Parameters
- config: HttpRequestConfig
Returns Promise<T>
- Defined in core/http-client.interface.ts:51

upload

upload<T>(config: UploadConfig): Promise<T>
Upload a file via multipart/form-data
Type Parameters
- T
Parameters
- config: UploadConfig
Returns Promise<T>
- Defined in core/http-client.interface.ts:56