hono-rate-limiter 0.2.1 → 0.2.2

package/README.md

@@ -15,7 +15,7 @@ limit repeated requests to public APIs and/or endpoints such as password reset.
 > [!WARNING]  
 > The `keyGenerator` function is currently under construction and needs to be defined for `hono-rate-limiter` to work properly in your environment. Please ensure that you define the `keyGenerator` function according to the documentation before using the library.
 
-## Usage
+##Usage
 
 ```ts
 import { rateLimiter } from "hono-rate-limiter";
@@ -24,7 +24,7 @@ const limiter = rateLimiter({
   windowMs: 15 * 60 * 1000, // 15 minutes
   limit: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes).
   standardHeaders: "draft-6", // draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header
-  keyGenerator: () => "<unique_key>", // Method to generate custom identifiers for clients.
+  keyGenerator: (c) => "<unique_key>", // Method to generate custom identifiers for clients.
   // store: ... , // Redis, MemoryStore, etc. See below.
 });
 
@@ -32,7 +32,7 @@ const limiter = rateLimiter({
 app.use(limiter);
 ```
 
-# Data Stores
+## Data Stores
 
 `hono-rate-limit` supports external data stores to synchronize hit counts across multiple processes and servers.
 
@@ -45,6 +45,7 @@ Here is a list of stores:
 | Name                                                                                 | Description                                                                                                                                                                                        |
 | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | MemoryStore                                                                          | (default) Simple in-memory option. Does not share state when the app has multiple processes or servers.                                                                                            |
+| [`@hono-rate-limiter/redis`](https://www.npm.im/@hono-rate-limiter/redis)            | A [Redis](https://redis.io/)-backed store, used with [`@vercel/kv`](https://www.npmjs.com/package/@vercel/kv) and [`@upstash/redis`](https://www.npmjs.com/package/@upstash/redis)                 |
 | [`rate-limit-redis`](https://npm.im/rate-limit-redis)                                | A [Redis](https://redis.io/)-backed store, more suitable for large or demanding deployments.                                                                                                       |
 | [`rate-limit-postresql`](https://www.npm.im/@acpr/rate-limit-postgresql)             | A [PostgreSQL](https://www.postgresql.org/)-backed store.                                                                                                                                          |
 | [`rate-limit-memecached`](https://npmjs.org/package/rate-limit-memcached)            | A [Memcached](https://memcached.org/)-backed store.                                                                                                                                                |
@@ -55,12 +56,12 @@ Here is a list of stores:
 
 Take a look at this [guide](https://express-rate-limit.mintlify.app/guides/creating-a-store) if you wish to create your own store.
 
-# Contributing
+## Contributing
 
 We would love to have more contributors involved!
 
 To get started, please read our [Contributing Guide](https://github.com/rhinobase/hono-rate-limiter/blob/main/CONTRIBUTING.md).
 
-# Credits
+## Credits
 
 The `hono-rate-limiter` project is heavily inspired by [express-rate-limit](https://github.com/express-rate-limit/express-rate-limit)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hono-rate-limiter",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "license": "MIT",
   "keywords": [
     "hono",
@@ -11,14 +11,14 @@
     "rate-limiter",
     "honojs"
   ],
-  "homepage": "https://github.com/rhinobase/hono-rate-limiter",
+  "homepage": "https://hono-rate-limiter.vercel.app",
   "publishConfig": {
     "access": "public"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/rhinobase/hono-rate-limiter.git",
-    "directory": "packages/ui"
+    "directory": "packages/core"
   },
   "bugs": {
     "url": "https://github.com/rhinobase/hono-rate-limiter/issues"

package/src/types.d.ts

@@ -10,6 +10,13 @@ export type ClientRateLimitInfo = {
     totalHits: number;
     resetTime?: Date;
 };
+/**
+ * Promisify<T> is a utility type that represents a value of type T or a Promise<T>.
+ * This type is useful for converting synchronous functions to asynchronous functions.
+ * @example
+ *   type getResult = Promisify<number>;  // getResult can be number or Promise<number>
+ *   type getUser = Promisify<User>;      // getUser can be User or Promise<User>
+ */
 export type Promisify<T> = T | Promise<T>;
 /**
  * The rate limit related information for each client included in the
@@ -148,7 +155,7 @@ export type Store = {
      *
      * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
      */
-    get?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+    get?: (key: string) => Promisify<ClientRateLimitInfo | undefined>;
     /**
      * Method to increment a client's hit counter.
      *
@@ -156,27 +163,27 @@ export type Store = {
      *
      * @returns {IncrementResponse | undefined} - The number of hits and reset time for that client.
      */
-    increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
+    increment: (key: string) => Promisify<IncrementResponse>;
     /**
      * Method to decrement a client's hit counter.
      *
      * @param key {string} - The identifier for a client.
      */
-    decrement: (key: string) => Promise<void> | void;
+    decrement: (key: string) => Promisify<void>;
     /**
      * Method to reset a client's hit counter.
      *
      * @param key {string} - The identifier for a client.
      */
-    resetKey: (key: string) => Promise<void> | void;
+    resetKey: (key: string) => Promisify<void>;
     /**
      * Method to reset everyone's hit counter.
      */
-    resetAll?: () => Promise<void> | void;
+    resetAll?: () => Promisify<void>;
     /**
      * Method to shutdown the store, stop timers, and release all resources.
      */
-    shutdown?: () => Promise<void> | void;
+    shutdown?: () => Promisify<void>;
     /**
      * Flag to indicate that keys incremented in one instance of this store can
      * not affect other instances. Typically false if a database is used, true for