@types/fast-ratelimit

Installation

npm install --save @types/fast-ratelimit

Summary

This package contains type definitions for fast-ratelimit (https://github.com/valeriansaliou/node-fast-ratelimit).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/fast-ratelimit.

index.d.ts

/**
 * Constructor options for fast-ratelimit.
 * {@link https://github.com/valeriansaliou/node-fast-ratelimit#1-create-the-rate-limiter}
 */
export interface FastRateLimitOptions {
    threshold: number; // available tokens over timespan
    ttl: number; // time-to-live value of token bucket (in seconds)
}

export class FastRateLimit {
    /**
     * FastRateLimit constructor
     * @param options
     */
    constructor(options: FastRateLimitOptions);

    /**
     * FastRateLimit.prototype.consumeSync
     */
    consumeSync(namespace: string): boolean;

    /**
     * FastRateLimit.prototype.hasTokenSync
     */
    hasTokenSync(namespace: string): boolean;

    /**
     * FastRateLimit.prototype.consume
     */
    consume(namespace: string): Promise<void>;

    /**
     * FastRateLimit.prototype.hasToken
     */
    hasToken(namespace: string): Promise<void>;
}

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: none

Credits

These definitions were written by Jørgen Vatle.