@opra/nestjs-rabbitmq 1.28.4 → 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.
Files changed (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +61 -3
  3. package/package.json +6 -5
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2022 Panates
3
+ Copyright (c) 2020-present Panates®
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,19 +1,77 @@
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-rabbitmq
2
8
 
9
+ NestJS RabbitMQ 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 RabbitMQ module for the [OPRA](https://oprajs.com) framework. Integrate RabbitMQ message consumers into your NestJS application with OPRA's schema-driven operation model.
23
+
24
+ ## Features
25
+
26
+ - **`OpraRabbitmqModule`** — Dynamically configurable NestJS module (`forRoot` / `forRootAsync`)
27
+ - Full NestJS dependency injection and provider support
28
+ - Interceptor middleware pipeline
29
+ - Content-type parsing, compression support, and dead-letter exchange handling
30
+
31
+ ## Installation
8
32
 
9
- ## Support
10
- You can report bugs and discuss features on the [GitHub issues](https://github.com/panates/opra/issues) page.
33
+ ```bash
34
+ npm install @opra/nestjs-rabbitmq
35
+ ```
36
+
37
+ ## Usage
38
+
39
+ ```typescript
40
+ import { Module } from '@nestjs/common';
41
+ import { OpraRabbitmqModule } from '@opra/nestjs-rabbitmq';
42
+
43
+ @Module({
44
+ imports: [
45
+ OpraRabbitmqModule.forRoot({
46
+ name: 'MyMQAPI',
47
+ url: 'amqp://localhost',
48
+ queues: [{ name: 'orders', prefetch: 10 }],
49
+ controllers: [OrdersController],
50
+ providers: [OrdersService],
51
+ }),
52
+ ],
53
+ })
54
+ export class AppModule {}
55
+ ```
56
+
57
+ ### Async configuration
58
+
59
+ ```typescript
60
+ OpraRabbitmqModule.forRootAsync({
61
+ useFactory: (config: ConfigService) => ({
62
+ url: config.get('RABBITMQ_URL'),
63
+ controllers: [OrdersController],
64
+ }),
65
+ inject: [ConfigService],
66
+ })
67
+ ```
11
68
 
12
69
  ## Node Compatibility
13
- - node >= 20.x
14
70
 
71
+ - node >= 20.x
15
72
 
16
73
  ## License
74
+
17
75
  Available under [MIT](LICENSE) license.
18
76
 
19
77
  [npm-image]: https://img.shields.io/npm/v/@opra/nestjs-rabbitmq
package/package.json CHANGED
@@ -1,18 +1,19 @@
1
1
  {
2
2
  "name": "@opra/nestjs-rabbitmq",
3
- "version": "1.28.4",
3
+ "version": "1.28.5",
4
4
  "description": "Opra NestJS RabbitMQ Module",
5
5
  "author": "Panates",
6
6
  "license": "MIT",
7
+ "homepage": "https://www.oprajs.com",
7
8
  "dependencies": {
8
9
  "@jsopen/objects": "^2.2.2",
9
10
  "tslib": "^2.8.1"
10
11
  },
11
12
  "peerDependencies": {
12
- "@opra/common": "^1.28.4",
13
- "@opra/core": "^1.28.4",
14
- "@opra/nestjs": "^1.28.4",
15
- "@opra/rabbitmq": "^1.28.4",
13
+ "@opra/common": "^1.28.5",
14
+ "@opra/core": "^1.28.5",
15
+ "@opra/nestjs": "^1.28.5",
16
+ "@opra/rabbitmq": "^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
  "@nestjs/microservices": "^10.0.0 || ^11.0.0",