@upstash/ratelimit 0.1.4-rc.1 → 0.1.4

package/README.md

@@ -1,12 +1,10 @@
-# Upstash Ratelimit
-
-An HTTP/REST based Redis client built on top of Upstash REST API.
-[Upstash REST API](https://docs.upstash.com/features/restapi).
+# Upstash RateLimit
 
 [![Tests](https://github.com/upstash/ratelimit/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/ratelimit/actions/workflows/tests.yaml)
 ![npm (scoped)](https://img.shields.io/npm/v/@upstash/ratelimit)
 
-It is the only connectionless (HTTP based) ratelimiter and designed for:
+It is the only connectionless (HTTP based) rate limiting library and designed
+for:
 
 - Serverless functions (AWS Lambda ...)
 - Cloudflare Workers
@@ -18,6 +16,7 @@ It is the only connectionless (HTTP based) ratelimiter and designed for:
 
 <!-- toc -->
 
+- [Docs](#docs)
 - [Quick Start](#quick-start)
   - [Install](#install)
     - [npm](#npm)
@@ -25,7 +24,8 @@ It is the only connectionless (HTTP based) ratelimiter and designed for:
   - [Create database](#create-database)
   - [Use it](#use-it)
   - [Block until ready](#block-until-ready)
-- [MultiRegionly replicated ratelimiting](#multiregionly-replicated-ratelimiting)
+  - [Ephemeral Cache](#ephemeral-cache)
+- [MultiRegion replicated ratelimiting](#multiregion-replicated-ratelimiting)
   - [Usage](#usage)
   - [Asynchronous synchronization between databases](#asynchronous-synchronization-between-databases)
   - [Example](#example)
@@ -49,6 +49,10 @@ It is the only connectionless (HTTP based) ratelimiter and designed for:
 
 <!-- tocstop -->
 
+## Docs
+
+[doc.deno.land](https://doc.deno.land/https://deno.land/x/upstash_ratelimit/src/mod.ts)
+
 ## Quick Start
 
 ### Install
@@ -180,11 +184,10 @@ return "Here you go!";
 ### Ephemeral Cache
 
 For extreme load or denial of service attacks, it might be too expensive to call
-redis for every incoming request, just to find out the request should be blocked
-because they have exceeded the limit.
+redis for every incoming request, just to find out it should be blocked because
+they have exceeded the limit.
 
-You can use an ephemeral in memory cache by passing the `ephemeralCache`
-options:
+You can use an ephemeral in memory cache by passing the `ephemeralCache` option:
 
 ```ts
 const cache = new Map(); // must be outside of your serverless function handler
@@ -197,21 +200,18 @@ const ratelimit = new Ratelimit({
 });
 ```
 
-If enabled, the ratelimiter will keep a global cache of identifiers and a reset
-timestamp, that have exhausted their ratelimit. In serverless environments this
-is only possible if you create the ratelimiter instance outside of your handler
-function. While the function is still hot, the ratelimiter can block requests
-without having to request data from redis, thus saving time and money.
-
-Whenever an identifier has exceeded its limit, the ratelimiter will add it to an
-internal list together with its reset timestamp. If the same identifier makes a
-new request before it is reset, we can immediately reject it.
+If enabled, the ratelimiter will keep a global cache of identifiers and their
+reset timestamps, that have exhausted their ratelimit. In serverless
+environments this is only possible if you create the cache or ratelimiter
+instance outside of your handler function. While the function is still hot, the
+ratelimiter can block requests without having to request data from redis, thus
+saving time and money.
 
-## MultiRegionly replicated ratelimiting
+## MultiRegion replicated ratelimiting
 
-Using a single redis instance has the downside of providing low latencies to the
-part of your userbase closest to the deployed db. That's why we also built
-`MultiRegionRatelimit` which replicates the state across multiple redis
+Using a single redis instance has the downside of providing low latencies only
+to the part of your userbase closest to the deployed db. That's why we also
+built `MultiRegionRatelimit` which replicates the state across multiple redis
 databases as well as offering lower latencies to more of your users.
 
 `MultiRegionRatelimit` does this by checking the current limit in the closest db
@@ -278,7 +278,7 @@ context.waitUntil(pending);
 ### Example
 
 Let's assume you have customers in the US and Europe. In this case you can
-create 2 regional redis databases on [Upastash](https://console.upstash.com) and
+create 2 regional redis databases on [Upstash](https://console.upstash.com) and
 your users will enjoy the latency of whichever db is closest to them.
 
 ## Ratelimiting algorithms

package/esm/multi.js

@@ -26,7 +26,9 @@ export class MultiRegionRatelimit extends Ratelimit {
             limiter: config.limiter,
             ctx: {
                 redis: config.redis,
-                cache: config.ephermeralCache ? new Cache() : undefined,
+                cache: config.ephermeralCache
+                    ? new Cache(config.ephermeralCache)
+                    : undefined,
             },
         });
     }

package/esm/single.js

@@ -201,8 +201,6 @@ export class RegionRatelimit extends Ratelimit {
      * rate.
      * - Allows to set a higher initial burst limit by setting `maxTokens` higher
      * than `refillRate`
-     *
-     * **Usage of Upstash Redis requests:**
      */
     static tokenBucket(
     /**

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "@upstash/ratelimit",
-  "version": "v0.1.4-rc.1",
+  "version": "v0.1.4",
   "description": "A serverless ratelimiter built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/multi.js

@@ -29,7 +29,9 @@ class MultiRegionRatelimit extends ratelimit_js_1.Ratelimit {
             limiter: config.limiter,
             ctx: {
                 redis: config.redis,
-                cache: config.ephermeralCache ? new cache_js_1.Cache() : undefined,
+                cache: config.ephermeralCache
+                    ? new cache_js_1.Cache(config.ephermeralCache)
+                    : undefined,
             },
         });
     }

package/script/single.js

@@ -204,8 +204,6 @@ class RegionRatelimit extends ratelimit_js_1.Ratelimit {
      * rate.
      * - Allows to set a higher initial burst limit by setting `maxTokens` higher
      * than `refillRate`
-     *
-     * **Usage of Upstash Redis requests:**
      */
     static tokenBucket(
     /**

package/types/single.d.ts

@@ -127,8 +127,6 @@ export declare class RegionRatelimit extends Ratelimit<RegionContext> {
      * rate.
      * - Allows to set a higher initial burst limit by setting `maxTokens` higher
      * than `refillRate`
-     *
-     * **Usage of Upstash Redis requests:**
      */
     static tokenBucket(
     /**