# amqp-poster

> Poster for rabbitmq. RPC

Latest version **3.0.1** (published 2018-11-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install amqp-poster
pnpm add amqp-poster
yarn add amqp-poster
bun add amqp-poster
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2018-11-28 |
| First published | 2017-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 3 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Yurii Chuhaienko |
| Maintainers | chuhaienko |
| Keywords | amqp, rabbitmq, rpc, poster, pubsub |

## Links

- npm: https://www.npmjs.com/package/amqp-poster
- Repository: https://github.com/chuhaienko/amqp-poster
- Homepage: https://github.com/chuhaienko/amqp-poster#readme
- Issues: https://github.com/chuhaienko/amqp-poster/issues
- npm.io page: https://npm.io/package/amqp-poster

## Dependencies (3)

- [joi](https://npm.io/package/joi.md) ^14.1.0
- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [amqplib](https://npm.io/package/amqplib.md) ^0.5.2

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 3.0.1 (latest) — 2018-11-28
- 3.0.0 — 2018-11-22
- 2.1.2 — 2018-05-18
- 2.1.1 — 2018-04-02
- 2.1.0 — 2018-02-18
- 2.0.1 — 2018-02-11
- 2.0.0 — 2018-02-10
- 1.2.1 — 2017-08-14
- 1.2.0 — 2017-08-12
- 1.1.0 — 2017-07-25
- 1.0.0 — 2017-07-25

## README

# AMQPPoster
A library for building communication between microservices.
It has simple and small API.
It works with amqplib and oriented to RabbitMQ.

# Installation
```
npm install amqp-poster
```

# API

## Instance
```
const Poster = require('amqp-poster');

(async () => {
	const poster = new Poster(options);
	
	await poster.init();
})();
```

### `options`
```
{
	name: 'TestService',
	uid:  'inst1',
	subscribe: [{
		exchange:       '',
		oncePerService: true
	}],
	prefetch: 10,
	server: {
		port:     5672,
		hostname: 'localhost',
		username: 'guest',
		password: 'guest'
	}
}
```
| key | required | type | description |
|-----|----------|------|-------------|
| name                       | true | string  | Service name. Also it is queue name for listening |
| uid                        |      | string  | String to identify owned queues |
| subscribe                  |      | array   | Collection of exchanges to subscribe |
| subscribe[].exchange       | true | string  | Name of exchange to subscribe |
| subscribe[].oncePerService |      | boolean | Apply round robin to messages for one service by name (default false) |
| prefetch                   |      | integer | How many messages process at one time (default 1) |
| server                     | true | string  | Connection url like 'amqp://guest:guest@localhost:5672' |
| server                     | true | object  | Object of connection config. May have next keys: protocol, hotname, port, username, password, locale, frameMax, heartbeat, vhost| 

## Send messages
```
try {
	let resp = await poster.send('ServiceName', reqObj)
	// some logic
} catch (err) {
	// Handle error
}
```

```reqObj``` - object or other variable to send

```respObj``` - response object

```err``` - error from respond-side

## Message Handler for incoming messages
```
poster.setMessageHandler(async (reqObj) => {
	// some logic
	
	// throw new Error('Some error');
	// or
	
	return respObj;
});
```

```reqObj``` - object or other variable was sent

```respObj``` - object or other variable to send as answer. Can be Promised value

## Publish broadcast message
```
await poster.publish('ExchangeName', reqObj);
```

## Handle broadcast messages
```
poster.setBroadcastHandler(function (reqObj) {
	// some logic
});
```

---
_Source: https://npm.io/package/amqp-poster · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
