HttpRequestConfig interface
Configuration for an HTTP request.
Properties
| data | The request body. |
| headers | Headers to merge with the client's default headers. |
| method | The HTTP method. |
| params | Query parameters to append to the URL. |
| response |
The format used to read the response body. |
| signal | A signal used to cancel the request. |
| timeout | The request timeout in milliseconds. |
| url | The absolute URL or path relative to the client's base URL. |
Property Details
data
The request body.
data?: unknownProperty Value
unknown
headers
Headers to merge with the client's default headers.
headers?: Record<string, string>Property Value
Record<string, string>
method
The HTTP method.
method: stringProperty Value
string
params
Query parameters to append to the URL.
params?: Record<string, string | undefined>Property Value
Record<string, string | undefined>
responseType
The format used to read the response body.
responseType?: "json" | "arraybuffer" | "stream"Property Value
"json" | "arraybuffer" | "stream"
signal
A signal used to cancel the request.
signal?: AbortSignalProperty Value
AbortSignal
timeout
The request timeout in milliseconds.
timeout?: numberProperty Value
number
url
The absolute URL or path relative to the client's base URL.
url: stringProperty Value
string