generated .d.ts files

Author: williamd5

lib/AttemptResult.d.ts

@@ -0,0 +1,28 @@
+import { RateLimit } from "./RateLimit";
+/**
+ * The result from a rate limit attempt
+ * @interface
+ */
+export interface AttemptResult {
+    /**
+     * The number of requests this rate limit allows per time window
+     */
+    limit: number;
+    /**
+     * The number of requests remaining in the current time window
+     */
+    remaining: number;
+    /**
+     * The number of seconds until the current time window resets
+     */
+    reset: number;
+    /**
+     * The rate limit that this attempt was made on
+     */
+    rateLimit: RateLimit;
+    /**
+     * Whether this attempt should be allowed to proceed. If false, the attempt is rate limited.
+     */
+    allow: boolean;
+}
+//# sourceMappingURL=AttemptResult.d.ts.map

lib/AttemptResult.d.ts.map

@@ -0,0 +1,119 @@
+import { AttemptResult } from "./AttemptResult";
+/**
+ * Rate limit
+ * @class
+ */
+export declare class RateLimit {
+    #private;
+    /**
+     * The number of requests allowed per time window
+     */
+    limit: number;
+    /**
+     * The time window in seconds (e.g. 60)
+     */
+    timeWindow: number;
+    /**
+     * Create a new rate limit
+     * @param {string} name - The name of the rate limit
+     * @param {number} limit - The number of requests allowed per time window (e.g. 60)
+     * @param {number} timeWindow - The time window in seconds (e.g. 60)
+     * @throws {Error} - If the rate limit already exists
+     */
+    constructor(name: string, limit: number, timeWindow: number);
+    /**
+     * Check the attempt state for a source ID without decrementing the remaining attempts
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     */
+    check(source: string): AttemptResult;
+    /**
+     * Make an attempt with a source ID
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @param {number} [attempts=1] - The number of attempts to make
+     */
+    attempt(source: string, attempts?: number): AttemptResult;
+    /**
+     * Reset limit for a source ID. The storage entry will be deleted and a new one will be created on the next attempt.
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     */
+    reset(source: string): void;
+    /**
+     * Set the remaining attempts for a source ID.
+     * > **Warning**: This is not recommended as the remaining attempts depend on the limit of the instance.
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @param {number} remaining - The number of remaining attempts
+     */
+    setRemaining(source: string, remaining: number): void;
+    /**
+     * Clear rate limit attempts storage. This is equivalent to resetting all rate limits.
+     */
+    clear(): void;
+    /**
+     * Delete the rate limit instance. After it is deleted, it should not be used any further without constructing a new instance.
+     */
+    delete(): void;
+    /**
+     * Get a rate limit instance
+     * @param {string} name - The name of the rate limit
+     * @static
+     */
+    static get(name: string): RateLimit | null;
+    /**
+     * Check the attempt state for a source ID without decrementing the remaining attempts
+     * @param {string} name - The name of the rate limit
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static check(name: string, source: string): AttemptResult;
+    /**
+     * Make an attempt with a source ID
+     * @param {string} name - The name of the rate limit
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @param {number} [attempts=1] - The number of attempts to make
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static attempt(name: string, source: string, attempts?: number): AttemptResult;
+    /**
+     * Reset limit for a source ID. The storage entry will be deleted and a new one will be created on the next attempt.
+     * @param {string} name - The name of the rate limit
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static reset(name: string, source: string): void;
+    /**
+     * Set the remaining attempts for a source ID.
+     * > **Warning**: This is not recommended as the remaining attempts depend on the limit of the instance.
+     * @param {string} name - The name of the rate limit
+     * @param {string} source - Unique source identifier (e.g. username, IP, etc.)
+     * @param {number} remaining - The number of remaining attempts
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static setRemaining(name: string, source: string, remaining: number): void;
+    /**
+     * Clear rate limit attempts storage. This is equivalent to resetting all rate limits.
+     * @param {string} name - The name of the rate limit
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static clear(name: string): void;
+    /**
+     * Delete the rate limit instance. After it is deleted, it should not be used any further without constructing a new instance.
+     * @param {string} name - The name of the rate limit
+     * @throws {Error} - If the rate limit does not exist
+     * @static
+     */
+    static delete(name: string): void;
+    /**
+     * Create a new rate limit
+     * @param {string} name - The name of the rate limit
+     * @param {number} limit - The number of attempts allowed per time window (e.g. 60)
+     * @param {number} timeWindow - The time window in seconds (e.g. 60)
+     * @static
+     */
+    static create(name: string, limit: number, timeWindow: number): RateLimit;
+}
+//# sourceMappingURL=RateLimit.d.ts.map