Interface RESTOptions

interface RESTOptions {
    agent?: null | Agent;
    baseURL?: string;
    disableLatencyCompensation?: boolean;
    host?: string;
    latencyThreshold?: number;
    ratelimiterOffset?: number;
    requestTimeout?: number;
    userAgent?: string;
}

Properties

agent? baseURL? disableLatencyCompensation? host? latencyThreshold? ratelimiterOffset? requestTimeout? userAgent?

Properties

Optionalagent

agent?: null | Agent

The agent to use for requests.

Default Value

null

OptionalbaseURL

baseURL?: string

The base URL used for requests.

Default Value

OptionaldisableLatencyCompensation

disableLatencyCompensation?: boolean

Built-in latency compensator.

Default Value

false

Optionalhost

host?: string

The Host header to use for requests.

Default Value

Parsed from baseURL

OptionallatencyThreshold

latencyThreshold?: number

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

Default Value

30000

OptionalratelimiterOffset

ratelimiterOffset?: number

In milliseconds, the time to offset ratelimit calculations by.

Default Value

0

OptionalrequestTimeout

requestTimeout?: number

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

Default Value

15000

OptionaluserAgent

userAgent?: string

User-Agent header to use for requests.

Settings

Member Visibility

On This Page

Properties