@upstash/ratelimit 2.0.1 → 2.0.3

package/README.md

@@ -76,7 +76,7 @@ For more information on getting started, you can refer to [our documentation](ht
 
 ## Documentation
 
-See [the documentation](https://upstash.com/docs/oss/sdks/ts/ratelimit/overview) for more information details about this package.
+See [the documentation](https://upstash.com/docs/redis/sdks/ratelimit-ts/overview) for more information details about this package.
 
 ## Contributing
 

package/dist/index.d.mts

@@ -20,12 +20,6 @@ interface EphemeralCache {
 type RegionContext = {
     redis: Redis;
     cache?: EphemeralCache;
-    scriptHashes: {
-        limitHash?: string;
-        getRemainingHash?: string;
-        resetHash?: string;
-    };
-    cacheScripts: boolean;
 };
 type MultiRegionContext = {
     regionContexts: Omit<RegionContext[], "cache">;
@@ -570,8 +564,12 @@ type RegionRatelimitConfig = {
      */
     analytics?: boolean;
     /**
-     * If enabled, lua scripts will be sent to Redis with SCRIPT LOAD durint the first request.
-     * In the subsequent requests, hash of the script will be used to invoke it
+     * @deprecated Has no affect since v2.0.3. Instead, hash values of scripts are
+     * hardcoded in the sdk and it attempts to run the script using EVALSHA (with the hash).
+     * If it fails, runs script load.
+     *
+     * Previously, if enabled, lua scripts were sent to Redis with SCRIPT LOAD durint the first request.
+     * In the subsequent requests, hash of the script would be used to invoke the scripts
      *
      * @default true
      */
@@ -769,4 +767,4 @@ declare namespace ipDenyList {
   };
 }
 
-export { Algorithm, Analytics, AnalyticsConfig, ipDenyList as IpDenyList, MultiRegionRatelimit, MultiRegionRatelimitConfig, RegionRatelimit as Ratelimit, RegionRatelimitConfig as RatelimitConfig };
+export { Algorithm, Analytics, AnalyticsConfig, Duration, ipDenyList as IpDenyList, MultiRegionRatelimit, MultiRegionRatelimitConfig, RegionRatelimit as Ratelimit, RegionRatelimitConfig as RatelimitConfig };

package/dist/index.d.ts

@@ -20,12 +20,6 @@ interface EphemeralCache {
 type RegionContext = {
     redis: Redis;
     cache?: EphemeralCache;
-    scriptHashes: {
-        limitHash?: string;
-        getRemainingHash?: string;
-        resetHash?: string;
-    };
-    cacheScripts: boolean;
 };
 type MultiRegionContext = {
     regionContexts: Omit<RegionContext[], "cache">;
@@ -570,8 +564,12 @@ type RegionRatelimitConfig = {
      */
     analytics?: boolean;
     /**
-     * If enabled, lua scripts will be sent to Redis with SCRIPT LOAD durint the first request.
-     * In the subsequent requests, hash of the script will be used to invoke it
+     * @deprecated Has no affect since v2.0.3. Instead, hash values of scripts are
+     * hardcoded in the sdk and it attempts to run the script using EVALSHA (with the hash).
+     * If it fails, runs script load.
+     *
+     * Previously, if enabled, lua scripts were sent to Redis with SCRIPT LOAD durint the first request.
+     * In the subsequent requests, hash of the script would be used to invoke the scripts
      *
      * @default true
      */
@@ -769,4 +767,4 @@ declare namespace ipDenyList {
   };
 }
 
-export { Algorithm, Analytics, AnalyticsConfig, ipDenyList as IpDenyList, MultiRegionRatelimit, MultiRegionRatelimitConfig, RegionRatelimit as Ratelimit, RegionRatelimitConfig as RatelimitConfig };
+export { Algorithm, Analytics, AnalyticsConfig, Duration, ipDenyList as IpDenyList, MultiRegionRatelimit, MultiRegionRatelimitConfig, RegionRatelimit as Ratelimit, RegionRatelimitConfig as RatelimitConfig };