/// interface BucketOptions { latencyRef?: { latency: number; }; reservedTokens?: number; } /** * Handle ratelimiting something * @prop {Number} interval How long (in ms) to wait between clearing used tokens * @prop {Number} lastReset Timestamp of last token clearing * @prop {Number} lastSend Timestamp of last token consumption * @prop {Number} tokenLimit The max number tokens the bucket can consume per interval * @prop {Number} tokens How many tokens the bucket has consumed in this interval */ declare class Bucket { interval: number; latencyRef: { latency: number; }; lastReset: number; lastSend: number; tokenLimit: number; tokens: number; reservedTokens: number; _queue: Array<{ func: Function; priority: boolean; }>; timeout: NodeJS.Timeout | null; /** * Construct a Bucket * @arg {Number} tokenLimit The max number of tokens the bucket can consume per interval * @arg {Number} interval How long (in ms) to wait between clearing used tokens * @arg {Object} [options] Optional parameters * @arg {Object} options.latencyRef A latency reference object * @arg {Number} options.latencyRef.latency Interval between consuming tokens * @arg {Number} options.reservedTokens How many tokens to reserve for priority operations */ constructor(tokenLimit: number, interval: number, options?: BucketOptions); check(): void; /** * Queue something in the Bucket * @arg {Function} func A callback to call when a token can be consumed * @arg {Boolean} [priority=false] Whether or not the callback should use reserved tokens */ queue(func: () => void, priority?: boolean): void; } export default Bucket; //# sourceMappingURL=Bucket.d.ts.map