Interface RateLimiterInterface

src/rate-limiters/rate-limiter-interface.ts:15–45

}

export interface RateLimiterInterface {
    /**
     * Rate Limiter driver.
     */
    driver?: RateLimiterInterface;

    /**
     * Consume the points for backend-received events.
     */
    consumeBackendEventPoints(points: number, app?: App, ws?: WebSocket): Promise<ConsumptionResponse>;

    /**
     * Consume the points for frontend-received events.
     */
    consumeFrontendEventPoints(points: number, app?: App, ws?: WebSocket): Promise<ConsumptionResponse>;

    /**
     * Consume the points for HTTP read requests.
     */
    consumeReadRequestsPoints(points: number, app?: App, ws?: WebSocket): Promise<ConsumptionResponse>;

    /**
     * Create a new rate limiter instance.
     */
    createNewRateLimiter(appId: string, maxPoints: number): RateLimiterAbstract;

    /**
     * Clear the rate limiter or active connections.
     */
    disconnect(): Promise<void>;
}