Class HttpProvider

HTTP provider for making API requests

Index

Constructors

Methods

delete get patch post put request

Constructors

constructor

new HttpProvider(
    baseUrl?: string,
    defaultHeaders?: Record<string, string>,
    timeout?: number,
): HttpProvider
Create a new HTTP provider
Parameters
- OptionalbaseUrl: string
  Optional base URL for all requests
- defaultHeaders: Record<string, string> = {}
  Default headers to include in all requests
- timeout: number = 30000
  Request timeout in milliseconds (default: 30000)
Returns HttpProvider
- Defined in providers/http.provider.ts:42

Methods

delete

delete<T = unknown>(
endpoint: string,
headers?: Record<string, string>,
): Promise<HttpResponse<T>>
Make a DELETE request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- Optionalheaders: Record<string, string>
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:176

get

get<T = unknown>(
    endpoint: string,
    params?: Record<string, string | number | boolean>,
    headers?: Record<string, string>,
): Promise<HttpResponse<T>>
Make a GET request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- Optionalparams: Record<string, string | number | boolean>
- Optionalheaders: Record<string, string>
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:143

patch

patch<T = unknown>(
    endpoint: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<HttpResponse<T>>
Make a PATCH request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:186

post

post<T = unknown>(
    endpoint: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<HttpResponse<T>>
Make a POST request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:154

put

put<T = unknown>(
    endpoint: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<HttpResponse<T>>
Make a PUT request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- Optionalbody: unknown
- Optionalheaders: Record<string, string>
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:165

request

request<T = unknown>(
endpoint: string,
options?: HttpRequestOptions,
): Promise<HttpResponse<T>>
Make an HTTP request
Type Parameters
- T = unknown
Parameters
- endpoint: string
- options: HttpRequestOptions = {}
Returns Promise<HttpResponse<T>>
- Defined in providers/http.provider.ts:76