@upstash/ratelimit 0.1.0-alpha.0

package/types/types.d.ts

@@ -0,0 +1,25 @@
+export declare type Redis = {
+    eval: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Promise<unknown>;
+};
+export declare type Context = {
+    redis: Redis;
+};
+export declare type RatelimitResponse = {
+    /**
+     * Whether the request may pass(true) or exceeded the limit(false)
+     */
+    success: boolean;
+    /**
+     * Maximum number of requests allowed within a window.
+     */
+    limit: number;
+    /**
+     * How many requests the user has left within the current window.
+     */
+    remaining: number;
+    /**
+     * Unix timestamp in milliseconds when the limits are reset.
+     */
+    reset: number;
+};
+export declare type Ratelimiter = (ctx: Context, identifier: string) => Promise<RatelimitResponse>;