# graphql-amqp-subscriptions

> GraphQL AMQP Subscriptions

Latest version **3.0.1** (published 2025-03-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install graphql-amqp-subscriptions
pnpm add graphql-amqp-subscriptions
yarn add graphql-amqp-subscriptions
bun add graphql-amqp-subscriptions
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2025-03-07 |
| First published | 2019-02-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 25.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 37 |
| Author | https://github.com/Surnet/graphql-amqp-subscriptions/graphs/contributors |
| Maintainers | chdanielmueller |
| Keywords | graphql, subscription, api, push, pull, amqp, rabbitmq, rabbit |

## Links

- npm: https://www.npmjs.com/package/graphql-amqp-subscriptions
- Repository: https://github.com/Surnet/graphql-amqp-subscriptions
- Issues: https://github.com/Surnet/graphql-amqp-subscriptions/issues
- npm.io page: https://npm.io/package/graphql-amqp-subscriptions

## Dependencies (2)

- [uuid](https://npm.io/package/uuid.md) 11.1.0
- [debug](https://npm.io/package/debug.md) 4.4.0

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2025-03-07
- 2.0.0 (beta) — 2024-01-19
- 3.0.0 — 2024-11-19
- 3.0.0-alpha.1 — 2024-11-14
- 1.2.1 — 2022-08-16
- 1.2.0 — 2021-05-18
- 1.1.2 — 2021-03-16
- 1.1.1 — 2020-09-17
- 1.1.0 — 2020-06-30
- 1.0.9 — 2020-05-13
- 1.0.8 — 2020-05-12
- 1.0.7 — 2020-05-05
- 1.0.6 — 2020-02-10
- 1.0.5 — 2020-01-09
- 1.0.4 — 2019-03-12
- … 5 more at https://npm.io/package/graphql-amqp-subscriptions/versions

## README

# graphql-amqp-subscriptions

This package implements the PubSubEngine Interface from the [graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions) package.
It allows you to connect your subscriptions manager to a AMQP PubSub mechanism.

This package is influenced by [graphql-redis-subscriptions](https://github.com/davidyaha/graphql-redis-subscriptions) and [graphql-rabbitmq-subscriptions](https://github.com/cdmbase/graphql-rabbitmq-subscriptions).

[![npm Version](https://img.shields.io/npm/v/graphql-amqp-subscriptions.svg)](https://www.npmjs.com/package/graphql-amqp-subscriptions)
[![npm Downloads](https://img.shields.io/npm/dm/graphql-amqp-subscriptions.svg)](https://www.npmjs.com/package/graphql-amqp-subscriptions)

## graphql-subscriptions@2

If you are using `graphql-subscriptions@2.x` please use `graphql-amqp-subscriptions@2`.

## Basic usage

```javascript
import { AMQPPubSub } from 'graphql-amqp-subscriptions';
import amqp from 'amqplib';

amqp.connect('amqp://guest:guest@localhost:5672?heartbeat=30')
.then(conn => {
  const pubsub = new AMQPPubSub({
    connection: conn
    /* exchange: {
       name: 'exchange',
       type: 'topic',
       options: {
         durable: false,
         autoDelete: true
       }
     },
     queue: {
       name: 'queue'
       options: {
         exclusive: true,
         durable: true,
         autoDelete: true
       },
       unbindOnDispose: false;
       deleteOnDispose: false;
     } */
  });
  // Use the pubsub instance from here on
})
.catch(err => {
  console.error(err);
});
```

## Benefits

- Reusing existing [amqplib](https://github.com/squaremo/amqp.node) Connection
- Reusing channels (one for subscriptions, one for publishing)
- Performance/Ressource-usage benefits on AMQP (RabbitMQ) because of the aforementioned reasons [more info](https://www.cloudamqp.com/blog/2018-01-19-part4-rabbitmq-13-common-errors.html)
- Using Topic Exchange (e.g. you publish to `agreements.eu.berlin.headstore` and subscribe to `agreements.eu.#`) [more info](https://www.cloudamqp.com/blog/2015-09-03-part4-rabbitmq-for-beginners-exchanges-routing-keys-bindings.html)

## Debug

This package uses Debug.
To show the logs run your app with the environment variable DEBUG="AMQPPubSub"

## Tests

You'll need to have a local AMPQ instance such as RabbitMQ running to run tests.

If you have [Docker](https://www.docker.com/), you can run:

```bash
docker run --hostname my-rabbit -p 5672:5672 rabbitmq:3
```

Then

```bash
npm test
```

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