@opra/nestjs-socketio 1.28.3 → 1.28.5
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/LICENSE +1 -1
- package/README.md +50 -3
- package/package.json +7 -6
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,19 +1,66 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<a href="https://oprajs.com">
|
|
4
|
+
<img src="https://oprajs.com/img/opra-header-block.webp" width="880" alt="OPRA — Open Platform for Rich APIs" />
|
|
5
|
+
</a>
|
|
6
|
+
|
|
1
7
|
# @opra/nestjs-socketio
|
|
2
8
|
|
|
9
|
+
NestJS Socket.IO module for the OPRA framework
|
|
10
|
+
|
|
3
11
|
[![NPM Version][npm-image]][npm-url]
|
|
4
12
|
[![NPM Downloads][downloads-image]][downloads-url]
|
|
5
13
|
[![CI Tests][ci-test-image]][ci-test-url]
|
|
6
14
|
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
7
15
|
|
|
16
|
+
[🌐 Documentation](https://oprajs.com) · [🚀 Getting Started](https://oprajs.com/docs/introduction) · [📦 Packages](https://github.com/panates/opra#packages) · [💬 Issues](https://github.com/panates/opra/issues)
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
NestJS Socket.IO module for the [OPRA](https://oprajs.com) framework. Add real-time WebSocket operations to your NestJS application using the same OPRA schema you use for HTTP.
|
|
23
|
+
|
|
24
|
+
## Features
|
|
25
|
+
|
|
26
|
+
- **`OpraSocketioModule`** — Dynamically configurable NestJS module (`forRoot` / `forRootAsync`)
|
|
27
|
+
- Configurable Socket.IO server options (port, CORS, etc.)
|
|
28
|
+
- Full NestJS dependency injection and provider support
|
|
29
|
+
- Interceptor middleware pipeline
|
|
30
|
+
- Unified operation model shared with HTTP endpoints
|
|
8
31
|
|
|
9
|
-
##
|
|
10
|
-
|
|
32
|
+
## Installation
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install @opra/nestjs-socketio
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
40
|
+
```typescript
|
|
41
|
+
import { Module } from '@nestjs/common';
|
|
42
|
+
import { OpraSocketioModule } from '@opra/nestjs-socketio';
|
|
43
|
+
|
|
44
|
+
@Module({
|
|
45
|
+
imports: [
|
|
46
|
+
OpraSocketioModule.forRoot({
|
|
47
|
+
name: 'MyWSAPI',
|
|
48
|
+
port: 3001,
|
|
49
|
+
serverOptions: { cors: { origin: '*' } },
|
|
50
|
+
controllers: [NotificationsController],
|
|
51
|
+
providers: [NotificationsService],
|
|
52
|
+
}),
|
|
53
|
+
],
|
|
54
|
+
})
|
|
55
|
+
export class AppModule {}
|
|
56
|
+
```
|
|
11
57
|
|
|
12
58
|
## Node Compatibility
|
|
13
|
-
- node >= 20.x
|
|
14
59
|
|
|
60
|
+
- node >= 20.x
|
|
15
61
|
|
|
16
62
|
## License
|
|
63
|
+
|
|
17
64
|
Available under [MIT](LICENSE) license.
|
|
18
65
|
|
|
19
66
|
[npm-image]: https://img.shields.io/npm/v/@opra/nestjs-socketio
|
package/package.json
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@opra/nestjs-socketio",
|
|
3
|
-
"version": "1.28.
|
|
3
|
+
"version": "1.28.5",
|
|
4
4
|
"description": "Opra NestJS Socket.io Module",
|
|
5
5
|
"author": "Panates",
|
|
6
6
|
"license": "MIT",
|
|
7
|
+
"homepage": "https://www.oprajs.com",
|
|
7
8
|
"dependencies": {
|
|
8
|
-
"@jsopen/objects": "^2.2.
|
|
9
|
+
"@jsopen/objects": "^2.2.2",
|
|
9
10
|
"tslib": "^2.8.1"
|
|
10
11
|
},
|
|
11
12
|
"peerDependencies": {
|
|
12
|
-
"@opra/common": "^1.28.
|
|
13
|
-
"@opra/core": "^1.28.
|
|
14
|
-
"@opra/nestjs": "^1.28.
|
|
15
|
-
"@opra/socketio": "^1.28.
|
|
13
|
+
"@opra/common": "^1.28.5",
|
|
14
|
+
"@opra/core": "^1.28.5",
|
|
15
|
+
"@opra/nestjs": "^1.28.5",
|
|
16
|
+
"@opra/socketio": "^1.28.5",
|
|
16
17
|
"@nestjs/common": "^10.0.0 || ^11.0.0",
|
|
17
18
|
"@nestjs/core": "^10.0.0 || ^11.0.0",
|
|
18
19
|
"socket.io": "^4.8.3"
|