mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
f9ca29e3e4
* chore: update readme badges * chore: add href * chore: other readmes * chore: reintroduce badge --------- Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
139 lines
5.5 KiB
Markdown
139 lines
5.5 KiB
Markdown
<div align="center">
|
|
<br />
|
|
<p>
|
|
<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
|
|
</p>
|
|
<br />
|
|
<p>
|
|
<a href="https://discord.gg/djs"><img src="https://img.shields.io/badge/join_us-on_discord-5865F2?logo=discord&logoColor=white" alt="Discord server" /></a>
|
|
<a href="https://www.npmjs.com/package/@discordjs/brokers"><img src="https://img.shields.io/npm/v/@discordjs/brokers.svg?maxAge=3600" alt="npm version" /></a>
|
|
<a href="https://www.npmjs.com/package/@discordjs/brokers"><img src="https://img.shields.io/npm/dt/@discordjs/brokers.svg?maxAge=3600" alt="npm downloads" /></a>
|
|
<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/tests.yml/badge.svg" alt="Build status" /></a>
|
|
<a href="https://github.com/discordjs/discord.js/commits/main/packages/brokers"><img alt="Last commit." src="https://img.shields.io/github/last-commit/discordjs/discord.js?logo=github&logoColor=ffffff&path=packages%2Fbrokers" /></a>
|
|
<a href="https://opencollective.com/discordjs"><img src="https://img.shields.io/opencollective/backers/discordjs?maxAge=3600&logo=opencollective" alt="backers" /></a>
|
|
<a href="https://codecov.io/gh/discordjs/discord.js"><img src="https://codecov.io/gh/discordjs/discord.js/branch/main/graph/badge.svg?precision=2&flag=brokers" alt="Code coverage" /></a>
|
|
</p>
|
|
<p>
|
|
<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
|
|
<a href="https://www.cloudflare.com"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-workers.png" alt="Cloudflare Workers" height="44" /></a>
|
|
</p>
|
|
</div>
|
|
|
|
## About
|
|
|
|
`@discordjs/brokers` is a powerful set of message brokers
|
|
|
|
## Installation
|
|
|
|
**Node.js 22.12.0 or newer is required.**
|
|
|
|
```sh
|
|
npm install @discordjs/brokers
|
|
yarn add @discordjs/brokers
|
|
pnpm add @discordjs/brokers
|
|
```
|
|
|
|
## Example usage
|
|
|
|
These examples use [ES modules](https://nodejs.org/api/esm.html#enabling).
|
|
|
|
### pub sub
|
|
|
|
```ts
|
|
// publisher.js
|
|
import { PubSubRedisBroker } from '@discordjs/brokers';
|
|
import Redis from 'ioredis';
|
|
|
|
// Considering this only pushes events, the group and name are not important.
|
|
const broker = new PubSubRedisBroker(new Redis(), { group: 'noop', name: 'noop' });
|
|
|
|
await broker.publish('test', 'Hello World!');
|
|
await broker.destroy();
|
|
|
|
// subscriber.js
|
|
import { PubSubRedisBroker } from '@discordjs/brokers';
|
|
import Redis from 'ioredis';
|
|
|
|
const broker = new PubSubRedisBroker(new Redis(), {
|
|
// This is the consumer group name. You should make sure to not re-use this
|
|
// across different applications in your stack, unless you absolutely know
|
|
// what you're doing.
|
|
group: 'subscribers',
|
|
// With the assumption that this service will scale to more than one instance,
|
|
// you MUST ensure `UNIQUE_CONSUMER_ID` is unique across all of them and
|
|
// also deterministic (i.e. if instance-1 restarts, it should still be instance-1)
|
|
name: `consumer-${UNIQUE_CONSUMER_ID}`,
|
|
});
|
|
broker.on('test', ({ data, ack }) => {
|
|
console.log(data);
|
|
void ack();
|
|
});
|
|
|
|
await broker.subscribe(['test']);
|
|
```
|
|
|
|
### RPC
|
|
|
|
```ts
|
|
// caller.js
|
|
import { RPCRedisBroker } from '@discordjs/brokers';
|
|
import Redis from 'ioredis';
|
|
|
|
const broker = new RPCRedisBroker(new Redis(), { group: 'noop', name: 'noop' });
|
|
|
|
console.log(await broker.call('testcall', 'Hello World!'));
|
|
await broker.destroy();
|
|
|
|
// responder.js
|
|
import { RPCRedisBroker } from '@discordjs/brokers';
|
|
import Redis from 'ioredis';
|
|
|
|
const broker = new RPCRedisBroker(new Redis(), {
|
|
// Equivalent to the group/name in pubsub, refer to the previous example.
|
|
group: 'responders',
|
|
name: `consumer-${UNIQUE_ID}`,
|
|
});
|
|
broker.on('testcall', ({ data, ack, reply }) => {
|
|
console.log('responder', data);
|
|
void ack();
|
|
void reply(`Echo: ${data}`);
|
|
});
|
|
|
|
await broker.subscribe(['testcall']);
|
|
```
|
|
|
|
## Links
|
|
|
|
- [Website][website] ([source][website-source])
|
|
- [Documentation][documentation]
|
|
- [Guide][guide] ([source][guide-source])
|
|
Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
|
|
- [discord.js Discord server][discord]
|
|
- [Discord Developers Discord server][discord-developers]
|
|
- [GitHub][source]
|
|
- [npm][npm]
|
|
- [Related libraries][related-libs]
|
|
|
|
## Contributing
|
|
|
|
Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
|
|
[documentation][documentation].
|
|
See [the contribution guide][contributing] if you'd like to submit a PR.
|
|
|
|
## Help
|
|
|
|
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
|
|
|
|
[website]: https://discord.js.org
|
|
[website-source]: https://github.com/discordjs/discord.js/tree/main/apps/website
|
|
[documentation]: https://discord.js.org/docs/packages/brokers/stable
|
|
[guide]: https://discordjs.guide
|
|
[guide-source]: https://github.com/discordjs/discord.js/tree/main/apps/guide
|
|
[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14
|
|
[discord]: https://discord.gg/djs
|
|
[discord-developers]: https://discord.gg/discord-developers
|
|
[source]: https://github.com/discordjs/discord.js/tree/main/packages/brokers
|
|
[npm]: https://www.npmjs.com/package/@discordjs/brokers
|
|
[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
|
|
[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md
|