Class HttpClient

Index

Constructors

constructor

new HttpClient(config: HttpClientConfig): HttpClient
Create a new HttpClient
Parameters
- config: HttpClientConfig
  HTTP client configuration
Returns HttpClient
- Defined in src/internal/http.ts:140

Accessors

baseUrl

get baseUrl(): string
Get the base URL for this client

Returns string
The base URL
- Defined in src/internal/http.ts:160

Methods

delete

delete<T = unknown>(path: string, options?: RequestOptions): Promise<T>
Perform a DELETE request
Type Parameters
- T = unknown
Parameters
- path: string
  Request path (relative to baseUrl)
- Optionaloptions: RequestOptions
  Request options
Returns Promise<T>
Response data

Throws
If the request fails
- Defined in src/internal/http.ts:236

get

get<T = unknown>(path: string, options?: RequestOptions): Promise<T>
Perform a GET request
Type Parameters
- T = unknown
Parameters
- path: string
  Request path (relative to baseUrl)
- Optionaloptions: RequestOptions
  Request options
Returns Promise<T>
Response data

Throws
If the request fails
- Defined in src/internal/http.ts:198

patch

patch<T = unknown>(
    path: string,
    body?: unknown,
    options?: RequestOptions,
): Promise<T>
Perform a PATCH request
Type Parameters
- T = unknown
Parameters
- path: string
  Request path (relative to baseUrl)
- Optionalbody: unknown
  Request body (will be JSON stringified)
- Optionaloptions: RequestOptions
  Request options
Returns Promise<T>
Response data

Throws
If the request fails
- Defined in src/internal/http.ts:249

post

post<T = unknown>(
    path: string,
    body?: unknown,
    options?: RequestOptions,
): Promise<T>
Perform a POST request
Type Parameters
- T = unknown
Parameters
- path: string
  Request path (relative to baseUrl)
- Optionalbody: unknown
  Request body (will be JSON stringified)
- Optionaloptions: RequestOptions
  Request options
Returns Promise<T>
Response data

Throws
If the request fails
- Defined in src/internal/http.ts:211

put

put<T = unknown>(
    path: string,
    body?: unknown,
    options?: RequestOptions,
): Promise<T>
Perform a PUT request
Type Parameters
- T = unknown
Parameters
- path: string
  Request path (relative to baseUrl)
- Optionalbody: unknown
  Request body (will be JSON stringified)
- Optionaloptions: RequestOptions
  Request options
Returns Promise<T>
Response data

Throws
If the request fails
- Defined in src/internal/http.ts:224

requestRaw

requestRaw(
    method: string,
    path: string,
    body?: unknown,
    options?: RequestOptions,
): Promise<Response>
Perform an HTTP request with streaming response support

Returns the raw Response object for streaming or custom handling. The caller is responsible for reading and closing the response body.
Parameters
- method: string
  HTTP method
- path: string
  Request path
- Optionalbody: unknown
  Request body
- Optionaloptions: RequestOptions
  Request options
Returns Promise<Response>
Raw Response object

Throws
If the request fails
- Defined in src/internal/http.ts:266

Class HttpClient

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HttpClient

Accessors

baseUrl

Returns string

Methods

delete

Type Parameters

Parameters

Returns Promise<T>

Throws

get

Type Parameters

Parameters

Returns Promise<T>

Throws

patch

Type Parameters

Parameters

Returns Promise<T>

Throws

post

Type Parameters

Parameters

Returns Promise<T>

Throws

put

Type Parameters

Parameters

Returns Promise<T>

Throws

requestRaw

Parameters

Returns Promise<Response>

Throws

Settings

On This Page