params |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
method |
string
|
|
HTTP Method (e.g. HEAD, GET, POST...) |
path |
string
|
|
Relative URL path |
body |
Object
|
string
|
<optional>
|
Body of a standard request. |
bulkBody |
Array.<Object>
|
string
|
<optional>
|
Body of a bulk request. |
querystring |
Array.<Object>
|
string
|
<optional>
|
Querystring params. |
|
options |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
id |
number
|
<optional>
|
Request ID |
context |
Object
|
<optional>
|
Object used for observability |
maxRetries |
number
|
<optional>
|
Max number of retries |
compression |
false
|
'gzip'
|
<optional>
|
Request body compression, if any |
asStream |
boolean
|
<optional>
|
Whether to emit the response as stream |
ignore |
Array.<number>
|
<optional>
|
Response's Error Status Codes to ignore |
headers |
Object
|
<optional>
|
Request headers |
querystring |
Object
|
string
|
<optional>
|
Request's query string |
requestTimeout |
number
|
<optional>
|
Max request timeout in milliseconds |
|
callback |
function
|
Callback that handles errors and response |