@veloxts/events 0.6.57 → 0.6.58
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 +2 -25
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,31 +1,8 @@
|
|
|
1
1
|
# @veloxts/events
|
|
2
2
|
|
|
3
|
-
> **Early Preview** - APIs may change
|
|
3
|
+
> **Early Preview (v0.6.x)** - APIs are stabilizing but may still change. Use with caution in production.
|
|
4
4
|
|
|
5
|
-
Real-time event broadcasting
|
|
6
|
-
|
|
7
|
-
## Installation
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install @veloxts/events
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Quick Start
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { eventsPlugin } from '@veloxts/events';
|
|
17
|
-
|
|
18
|
-
app.use(eventsPlugin({ driver: 'ws', path: '/ws' }));
|
|
19
|
-
|
|
20
|
-
// Broadcast an event
|
|
21
|
-
await ctx.broadcast({
|
|
22
|
-
channel: 'orders.123',
|
|
23
|
-
event: 'order.shipped',
|
|
24
|
-
data: { trackingNumber: 'TRACK123' },
|
|
25
|
-
});
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
See [GUIDE.md](./GUIDE.md) for detailed documentation.
|
|
5
|
+
Real-time event broadcasting for VeloxTS Framework - provides WebSocket and SSE drivers with channel authorization and optional Redis pub/sub for horizontal scaling. Learn more at [@veloxts/velox](https://www.npmjs.com/package/@veloxts/velox).
|
|
29
6
|
|
|
30
7
|
## License
|
|
31
8
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veloxts/events",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.58",
|
|
4
4
|
"description": "Real-time event broadcasting for VeloxTS framework",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"superjson": "2.2.2",
|
|
31
31
|
"ws": "8.18.2",
|
|
32
32
|
"zod": "3.24.4",
|
|
33
|
-
"@veloxts/core": "0.6.
|
|
33
|
+
"@veloxts/core": "0.6.58"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
36
|
"fastify": "^5.0.0",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"ioredis": "5.6.1",
|
|
50
50
|
"typescript": "5.8.3",
|
|
51
51
|
"vitest": "4.0.16",
|
|
52
|
-
"@veloxts/testing": "0.6.
|
|
52
|
+
"@veloxts/testing": "0.6.58"
|
|
53
53
|
},
|
|
54
54
|
"publishConfig": {
|
|
55
55
|
"access": "public"
|