discord.js | PubSubRedisBroker

Search...

PubSubRedisBroker

export declare class PubSubRedisBroker<TEvents extends Record<string, any>> extends BaseRedisBroker<TEvents> implements IPubSubBroker<TEvents>

export declare class PubSubRedisBroker<TEvents extends Record<string, any>> extends BaseRedisBroker<TEvents> implements IPubSubBroker<TEvents>

PubSub broker powered by Redis

Example

// publisher.js
import { PubSubRedisBroker } from '@discordjs/brokers';
import Redis from 'ioredis';

const broker = new PubSubRedisBroker({ redisClient: new Redis() });

await broker.publish('test', 'Hello World!');
await broker.destroy();

// subscriber.js
import { PubSubRedisBroker } from '@discordjs/brokers';
import Redis from 'ioredis';

const broker = new PubSubRedisBroker({ redisClient: new Redis() });
	broker.on('test', ({ data, ack }) => {
	console.log(data);
	void ack();
});

await broker.subscribe('subscribers', ['test']);

// publisher.js
import { PubSubRedisBroker } from '@discordjs/brokers';
import Redis from 'ioredis';

const broker = new PubSubRedisBroker({ redisClient: new Redis() });

await broker.publish('test', 'Hello World!');
await broker.destroy();

// subscriber.js
import { PubSubRedisBroker } from '@discordjs/brokers';
import Redis from 'ioredis';

const broker = new PubSubRedisBroker({ redisClient: new Redis() });
	broker.on('test', ({ data, ack }) => {
	console.log(data);
	void ack();
});

await broker.subscribe('subscribers', ['test']);

Extends

BaseRedisBroker<TEvents>

Implements

IPubSubBroker<TEvents>

Name	Constraints	Optional	Default	Description
TEvents	Record<string, any>	No		None

Protected

listening:boolean

Whether this broker is currently polling events

Inherited from BaseRedisBroker

ProtectedReadonly

options:Required<RedisBrokerOptions>

Options this broker is using

Inherited from BaseRedisBroker

StaticReadonly

STREAM_DATA_KEY:

Used for Redis queues, see the 3rd argument taken by xadd

Inherited from BaseRedisBroker

ProtectedReadonly

streamReadClient:Redis

Internal copy of the Redis client being used to read incoming payloads

Inherited from BaseRedisBroker

ProtectedReadonly

subscribedEvents:Set<string>

Events this broker has subscribed to

Inherited from BaseRedisBroker

destroy():Promise<void>

Destroys the broker, closing all connections

Inherited from BaseRedisBroker

Protected

emitEvent(id, group, event, data):void

Name	Type	Optional	Description
id	Buffer_2	No	None
group	string	No	None
event	string	No	None
data	unknown	No	None

Protected

listen(group):Promise<void>

Begins polling for events, firing them to listen

Name	Type	Optional	Description
group	string	No	None

Inherited from BaseRedisBroker

publish(event, data):Promise<void>

Publishes an event

Name	Type	Optional	Description
event	T	No	None
data	TEvents[T]	No	None

Subscribes to the given events, grouping them by the given group name

Name	Type	Optional	Description
group	string	No	None
events	(keyof TEvents)[]	No	None

Inherited from BaseRedisBroker

unsubscribe(group, events):Promise<void>

Unsubscribes from the given events - it's required to pass the same group name as when subscribing for proper cleanup

Name	Type	Optional	Description
group	string	No	None
events	(keyof TEvents)[]	No	None

Inherited from BaseRedisBroker