RateLimiter class


The rate limiter class. Used to send requests to the API.

Signature:

export declare class RateLimiter 

Constructor

new RateLimiter (client: Client, options: RateLimiterOptions, apiKey: string)

Constructs a new instance of the RateLimiter class.

Parameters:

ParameterTypeDescription
clientClient
optionsRateLimiterOptions
apiKeyString

Methods

.request ()

Send a request to the API.

Signature:

request(url: string, options: ApiRequestOptions): Promise<AxiosResponse>;

Parameters:

ParameterTypeDescription
urlStringThe URL to send the request to.
optionsApiRequestOptionsThe request options.

Return type: Promise < AxiosResponse >


Table of Contents