@taukirsheikh/rate-limiter 1.1.0 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @taukirsheikh/rate-limiter
|
|
2
2
|
|
|
3
|
-
A powerful rate limiter for Node.js with TypeScript support and Redis clustering
|
|
3
|
+
A powerful rate limiter for Node.js with TypeScript support and Redis clustering built from scratch.
|
|
4
4
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
@@ -18,13 +18,13 @@ A powerful rate limiter for Node.js with TypeScript support and Redis clustering
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
-
npm install @
|
|
21
|
+
npm install @taukirsheikh/rate-limiter
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Quick Start
|
|
25
25
|
|
|
26
26
|
```typescript
|
|
27
|
-
import { RateLimiter, Priority } from '@
|
|
27
|
+
import { RateLimiter, Priority } from '@taukirsheikh/rate-limiter';
|
|
28
28
|
|
|
29
29
|
// Create a limiter
|
|
30
30
|
const limiter = new RateLimiter({
|
|
@@ -89,7 +89,7 @@ const results = await Promise.all([
|
|
|
89
89
|
### Priority Queuing
|
|
90
90
|
|
|
91
91
|
```typescript
|
|
92
|
-
import { Priority } from '@
|
|
92
|
+
import { Priority } from '@taukirsheikh/rate-limiter';
|
|
93
93
|
|
|
94
94
|
// Critical jobs run first
|
|
95
95
|
await limiter.schedule(
|
|
@@ -206,7 +206,7 @@ For multi-server deployments, use `DistributedRateLimiter` to coordinate rate li
|
|
|
206
206
|
### Quick Start (Redis)
|
|
207
207
|
|
|
208
208
|
```typescript
|
|
209
|
-
import { DistributedRateLimiter } from '@
|
|
209
|
+
import { DistributedRateLimiter } from '@taukirsheikh/rate-limiter';
|
|
210
210
|
|
|
211
211
|
const limiter = new DistributedRateLimiter({
|
|
212
212
|
id: 'api-limiter', // Shared ID across all servers
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@taukirsheikh/rate-limiter",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.2",
|
|
4
4
|
"description": "A powerful rate limiter with concurrency control, priority queues, task scheduling, and Redis clustering support",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|