Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skelmen/nestjs-azure-service-bus
Azure Service Bus module for Nest.js framework
https://github.com/skelmen/nestjs-azure-service-bus
amqp azure azure-service-bus message-queue nest nestjs nestjs-module nodejs service-bus
Last synced: about 2 months ago
JSON representation
Azure Service Bus module for Nest.js framework
- Host: GitHub
- URL: https://github.com/skelmen/nestjs-azure-service-bus
- Owner: skelmen
- License: mit
- Created: 2023-02-01T17:50:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-21T09:11:28.000Z (almost 2 years ago)
- Last Synced: 2024-04-25T07:02:20.134Z (9 months ago)
- Topics: amqp, azure, azure-service-bus, message-queue, nest, nestjs, nestjs-module, nodejs, service-bus
- Language: TypeScript
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Azure Service Bus module for Nest.js framework
## Description
Azure Service Bus is a cloud based message broker. You can use Azure Service Bus to send messages between applications or services. It supports AMQP / STOMP protocols, automatic scalability and disaster recovery.
Azure Service Bus module for Nest.js based on the @azure/service-bus package.
## Installation
```bash
$ npm i --save @skelmen/nestjs-azure-service-bus-module
```
## Usage
Recommended Nest.js version >=10.0.0
#### Import module
```ts
AzureServiceBusModule.forRootAsync([
{
name: 'provider_name_1',
useFactory: (configService: ConfigService) => ({
connectionString: configService.get('connectionString1'),
options: {} // Azure service bus client options
}),
inject: [ConfigService],
},
{
name: 'provider_name_2',
useFactory: () => ({
connectionString: 'azure_service_bus_connection_string',
options: {} // Azure service bus client options
}),
},
]),
```
#### Service example
For messages scheduling pass `updateTime` param to `emit` method.
```ts
@Injectable()
export class AppService {
constructor(
@Inject('provider_name_1') private readonly serviceBusClient: AzureServiceBusClient,
) { }
async getData(){
const options = {}; // Azure options for configuring tracing and the abortSignal
const payload = {
body: {
id: '39219'
}
};
await this.serviceBusClient.emit({ payload, options });
}
async scheduleData(){
const options = {};
const payload = {
body: {
id: '39219'
}
};
// (Optional) For scheduling messages
const updateTime = new Date('2023-02-20 13:26:00+02');
await this.serviceBusClient.emit({ payload, options, updateTime });
}
}
```
#### Handle events
Add handler to your any service
```ts
@Subscribe('service-bus-queue-name') // Service bus queue name
async handler({ body }) {
console.log(body);
}
```
## License
This project is licensed under the [MIT License](LICENSE.md)