Interface RequestHandlerInstanceOptions

The agent to use for requests.

Default Value

null
Copy

The base URL to use for requests - must be a fully qualified url.

Default Value

https://discordapp.com/api/v{REST_VERSION}
Copy

If the built-in latency compensator should be disabled.

Default Value

false
Copy

If redirects should be followed.

Default Value

false
Copy

The Host header to use for requests.

Default Value

Parsed from baseURL

In milliseconds, the average request latency at which to start emitting latency errors.

Default Value

30000
Copy

In milliseconds, the maximum ratelimit delay (in milliseconds) the lib will internally wait for to retry the request. If a ratelimit resets after this window, an error will be thrown instead.

Note

This currently defaults to Infinity for backwards compatibility, but this will be changed in 1.12.0.

Default Value

Infinity
Copy

In milliseconds, the time to offset ratelimit calculations by.

Default Value

0
Copy

In milliseconds, how long to wait until a request is timed out.

Default Value

15000
Copy

A value for the X-Super-Properties header, sent with all requests if present. This can be used to reveal some properties only visible to >= client builds. Provide either an object, or a base64 encoded string.

Example

eyJjbGllbnRfYnVpbGRfbnVtYmVyIjoxNjI5OTJ9
Copy

Example

{ client_build_number: 162992 }
Copy

Default Value

null
Copy

The User-Agent header to use for requests.

Default Value

Oceanic/{VERSION} (https://github.com/OceanicJS/Oceanic)
Copy