docs: added ConnectionInfo details (#2940).
This commit is contained in:
parent
64744990ff
commit
1934ad3b48
@ -28,7 +28,7 @@ _property: connection.allowInsecureAuthentication => boolean
|
|||||||
Allow [[link-wiki-basicauth]] over non-secure HTTP. The default is false.
|
Allow [[link-wiki-basicauth]] over non-secure HTTP. The default is false.
|
||||||
|
|
||||||
_property: connection.timeout => number
|
_property: connection.timeout => number
|
||||||
How long to wait before rejecting with a //timeout// error.
|
How long to wait (in ms) before rejecting with a //timeout// error. (default: ``120000``).
|
||||||
|
|
||||||
_property: connection.headers => { [ key: string]: string }
|
_property: connection.headers => { [ key: string]: string }
|
||||||
Additional headers to include in the connection.
|
Additional headers to include in the connection.
|
||||||
@ -40,10 +40,27 @@ platforms. On some services, such as Cloudflare Workers, specifying any
|
|||||||
value (inclluding the default values) will cause failure. Setting this
|
value (inclluding the default values) will cause failure. Setting this
|
||||||
to true will prevent any values being passed to the underlying API.
|
to true will prevent any values being passed to the underlying API.
|
||||||
|
|
||||||
|
_property: connection.errorPassThrough => boolean
|
||||||
|
If false, any server error is thrown as a SERVER_ERROR, otherwise a
|
||||||
|
the processFunc is called with response including the error status intact. (default: ``false``)
|
||||||
|
|
||||||
|
_property: connection.allowGzip => boolean
|
||||||
|
Allow Gzip responses. (default: ``false``)
|
||||||
|
|
||||||
|
_property: connection.throttleLimit => boolean
|
||||||
|
How many times to retry in the event of a 429 status code.
|
||||||
|
|
||||||
|
_property: connection.throttleSlotInterval => boolean
|
||||||
|
The exponential back-off slot delay (i.e. omega), creating a staggered, increasing random delay on retries.
|
||||||
|
|
||||||
|
_property: connection.throttleCallback => boolean
|
||||||
|
Callback that allows application level hints to retry (within the throttleLimit) or quick fail.
|
||||||
|
|
||||||
|
|
||||||
_heading: PollOptions @<PollOptions>
|
_heading: PollOptions @<PollOptions>
|
||||||
|
|
||||||
_property: options.timeout => number
|
_property: options.timeout => number
|
||||||
The amount of time allowed to elapse before triggering a timeout
|
The amount of time (in ms) allowed to elapse before triggering a timeout
|
||||||
error.
|
error.
|
||||||
|
|
||||||
_property: options.floor => number
|
_property: options.floor => number
|
||||||
|
Loading…
Reference in New Issue
Block a user