Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bugs5382/fastify-rabbitmq
A Fastify RabbitMQ Plugin Developed in Pure TypeScript using the AMQPLIB
https://github.com/bugs5382/fastify-rabbitmq
fastify fastify-plugin rabbitmq typescript
Last synced: 2 months ago
JSON representation
A Fastify RabbitMQ Plugin Developed in Pure TypeScript using the AMQPLIB
- Host: GitHub
- URL: https://github.com/bugs5382/fastify-rabbitmq
- Owner: Bugs5382
- License: mit
- Created: 2023-08-03T11:59:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-17T00:22:27.000Z (3 months ago)
- Last Synced: 2024-11-17T00:26:36.040Z (3 months ago)
- Topics: fastify, fastify-plugin, rabbitmq, typescript
- Language: TypeScript
- Homepage:
- Size: 235 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Fastify RabbitMQ
A Fastify RabbitMQ Plugin Developed in Pure TypeScript.
It uses the [node-rabbitmq-client](https://github.com/cody-greene/node-rabbitmq-client/) plugin as a wrapper.
The build exports this to valid ESM and CJS for ease of cross-compatibility.
If you are using this NPM package, please consider giving it a :star: star.
This will increase its visibility and solicit more contribution from the outside.
## Table of Contents
1. [Install](#install)
2. [Basic Usage](#basic-usage)
3. [Full Documentation](#full-documentation)
1. [Options](#options)
4. [Acknowledgements](#acknowledgements)
5. [License](#license)
## Install
```
npm install fastify-rabbitmq
```
## Basic Usage
Register this as a plugin.
Make sure it is loaded before any **_routes_** are loaded.
### Quick Setup on the Server Side
```typescript
export default fp((fastify, options, done) => {
void fastify.register(fastifyRabbit, {
connection: `amqp://guest:guest@localhost`,
});
void fastify.ready().then(async () => {
const consumer = fastify.rabbitmq.createConsumer(
{
queue: "foo",
queueOptions: { durable: true },
},
async (msg: any) => {
console.log(msg); // ==> bar
},
);
});
});
```
### Quick Setup on the Client Side
Within any "endpoint" function, or if you have access to `fastify.rabbitmq` you can then call:
```js
fastify.get("/rabbitmq", async (request, reply) => {
let pub = request.rabbitmq.createPublisher({
confirm: true,
maxAttempts: 1,
});
await pub.send("foo", "bar"); // ==> sent to foo queue
});
```
Sending the string `bar` to the queue called `foo`.
## Full Documentation
### Options
```typescript
export interface FastifyRabbitMQOptions {
/** Connection String or object pointing to the RabbitMQ Broker Services */
connection: string | ConnectionOptions;
/** To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time. */
namespace?: string;
}
```
#### FastifyRabbitMQOptions
##### `connection`
Connection String or object pointing to the RabbitMQ Broker Services.
This can be an object of `ConnectionOptions` from the `node-rabbitmq-client` plugin options.
##### `namespace`
If you need more than one "connection" to a different set and/or array of RabbitMQ servers,
either on network or cloud, each registration of the plugin needs it to be in its own namespace.
If the name space is duplicated, it will fail to load.
## Acknowledgements
- [node-rabbitmq-client](https://www.npmjs.com/package/rabbitmq-client)
- [fastify](https://fastify.dev/)
- ... and my Wife and Baby Girl.
## License
Licensed under [MIT](./LICENSE).