@upstash/ratelimit 0.2.0 → 0.3.0-rc.0

package/types/ratelimit.d.ts

@@ -1,3 +1,4 @@
+import { Analytics, Geo } from "./analytics.js";
 import type { Algorithm, Context, RatelimitResponse } from "./types.js";
 export declare class TimeoutError extends Error {
     constructor();
@@ -44,6 +45,13 @@ export type RatelimitConfig<TContext> = {
      * Use this if you want to allow requests in case of network problems
      */
     timeout?: number;
+    /**
+     * If enabled, the ratelimiter will store analytics data in redis, which you can check out at
+     * https://upstash.com/ratelimit
+     *
+     * @default true
+     */
+    analytics?: boolean;
 };
 /**
  * Ratelimiter using serverless redis from https://upstash.com/
@@ -65,6 +73,7 @@ export declare abstract class Ratelimit<TContext extends Context> {
     protected readonly ctx: TContext;
     protected readonly prefix: string;
     protected readonly timeout?: number;
+    protected readonly analytics?: Analytics;
     constructor(config: RatelimitConfig<TContext>);
     /**
      * Determine if a request should pass or be rejected based on the identifier and previously chosen ratelimit.
@@ -85,7 +94,9 @@ export declare abstract class Ratelimit<TContext extends Context> {
      *  return "Yes"
      * ```
      */
-    limit: (identifier: string) => Promise<RatelimitResponse>;
+    limit: (identifier: string, req?: {
+        geo?: Geo;
+    }) => Promise<RatelimitResponse>;
     /**
      * Block until the request may pass or timeout is reached.
      *

package/types/single.d.ts

@@ -1,6 +1,6 @@
 import type { Duration } from "./duration.js";
 import type { Algorithm, RegionContext } from "./types.js";
-import type { Redis } from "./types.js";
+import type { Redis } from "./deps/deno.land/x/upstash_redis@v1.19.3/mod.js";
 import { Ratelimit } from "./ratelimit.js";
 export type RegionRatelimitConfig = {
     /**
@@ -48,6 +48,13 @@ export type RegionRatelimitConfig = {
      * Use this if you want to allow requests in case of network problems
      */
     timeout?: number;
+    /**
+     * If enabled, the ratelimiter will store analytics data in redis, which you can check out at
+     * https://upstash.com/ratelimit
+     *
+     * @default true
+     */
+    analytics?: boolean;
 };
 /**
  * Ratelimiter using serverless redis from https://upstash.com/

package/types/types.d.ts

@@ -1,7 +1,4 @@
-export interface Redis {
-    eval: (script: string, keys: string[], values: unknown[]) => Promise<unknown>;
-    sadd: (key: string, ...members: string[]) => Promise<number>;
-}
+import type { Redis } from "./deps/deno.land/x/upstash_redis@v1.19.3/mod.js";
 /**
  * EphemeralCache is used to block certain identifiers right away in case they have already exceedd the ratelimit.
  */