turbopulse 1.0.2 → 1.0.4
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 +34 -7
- package/package.json +1 -1
- package/turbopulse.darwin-arm64.node +0 -0
- package/turbopulse.linux-x64-gnu.node +0 -0
package/README.md
CHANGED
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Fast, zero-copy distributed rate limiter and background job queue for Node.js, backed by native Rust (`napi-rs`) and Redis.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/turbopulse)
|
|
6
|
+
[](https://www.npmjs.com/package/turbopulse)
|
|
7
|
+
[](https://nodejs.org)
|
|
5
8
|
[](https://github.com/Saiop68/turbopulse/actions)
|
|
6
9
|
[](https://Saiop68.github.io/turbopulse/)
|
|
7
10
|
[](LICENSE)
|
|
@@ -12,7 +15,7 @@ Fast, zero-copy distributed rate limiter and background job queue for Node.js, b
|
|
|
12
15
|
|
|
13
16
|
- [Core Architecture](#core-architecture)
|
|
14
17
|
- [Automatic Engine Capabilities](#automatic-engine-capabilities)
|
|
15
|
-
- [Installation](#installation)
|
|
18
|
+
- [Installation & NPM Package Details](#installation--npm-package-details)
|
|
16
19
|
- [Engine Modes & Factory Initialization](#engine-modes--factory-initialization)
|
|
17
20
|
- [Rate Limiting Guide](#rate-limiting-guide)
|
|
18
21
|
- [Basic Rate Limiting](#basic-rate-limiting)
|
|
@@ -92,18 +95,42 @@ TurboPulse automates resilience, scheduling, and connection management without r
|
|
|
92
95
|
|
|
93
96
|
---
|
|
94
97
|
|
|
95
|
-
## Installation
|
|
98
|
+
## Installation & NPM Package Details
|
|
99
|
+
|
|
100
|
+
| Property | Value |
|
|
101
|
+
| :--- | :--- |
|
|
102
|
+
| **NPM Package** | [`turbopulse`](https://www.npmjs.com/package/turbopulse) |
|
|
103
|
+
| **Latest Release** | `1.0.4` (dist-tag `latest`) |
|
|
104
|
+
| **License** | MIT |
|
|
105
|
+
| **Node.js Engine** | `>=18.0.0` (LTS 18, 20, 22, 24) |
|
|
106
|
+
| **TypeScript Types** | Built-in (`dist/index.d.ts`) |
|
|
107
|
+
| **Native Runtime** | Pre-compiled via `napi-rs` (Node-API v8) |
|
|
108
|
+
|
|
109
|
+
### Install via your package manager:
|
|
96
110
|
|
|
97
111
|
```bash
|
|
112
|
+
# npm
|
|
98
113
|
npm install turbopulse
|
|
114
|
+
|
|
115
|
+
# pnpm
|
|
116
|
+
pnpm add turbopulse
|
|
117
|
+
|
|
118
|
+
# yarn
|
|
119
|
+
yarn add turbopulse
|
|
120
|
+
|
|
121
|
+
# bun
|
|
122
|
+
bun add turbopulse
|
|
99
123
|
```
|
|
100
124
|
|
|
101
|
-
Pre-compiled
|
|
102
|
-
|
|
103
|
-
-
|
|
104
|
-
|
|
125
|
+
### Pre-compiled Native Platform Binaries
|
|
126
|
+
|
|
127
|
+
TurboPulse bundles pre-compiled native binaries out of the box using Node-API (`napi-rs`):
|
|
128
|
+
|
|
129
|
+
- **Linux:** `x86_64` (glibc), `aarch64` (ARM64 / AWS Graviton), `musl` (Alpine Linux Docker containers)
|
|
130
|
+
- **macOS:** Apple Silicon (`aarch64-apple-darwin` M1/M2/M3/M4), Intel (`x86_64-apple-darwin`)
|
|
131
|
+
- **Windows:** `x86_64` (`x86_64-pc-windows-msvc`)
|
|
105
132
|
|
|
106
|
-
No local Rust toolchain or
|
|
133
|
+
> **Zero Compilation Friction:** No local Rust toolchain, C++ compiler, `node-gyp`, or Python installation is required on your development machine or production deployment servers. The appropriate native binary is automatically selected and loaded at runtime.
|
|
107
134
|
|
|
108
135
|
---
|
|
109
136
|
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|