class PubSubRedisBroker

implements

extends

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

PubSub broker powered by Redis

Type Parameters

TEvents extends Record<string, any>

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

protectedreadonly
redisClient : Redis

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: Buffer
group: string
event: string
data: unknown
) : void

protected
listen() : Promise<void>

Begins polling for events, firing them to listen

Inherited from: BaseRedisBroker

publish<
Event extends keyof TEvents
>(
event: Event
data: TEvents[Event]
) : Promise<void>

Publishes an event

Subscribes to the given events

Inherited from: BaseRedisBroker

unsubscribe(
events: (keyof TEvents)[]
) : Promise<void>

Unsubscribes from the given events

Inherited from: BaseRedisBroker

class PubSubRedisBroker

implements

extends

Table of contents

Properties

Methods

Type Parameters

TEvents extends Record<string, any>

Properties

protected
listening : boolean

protectedreadonly
options : Required<RedisBrokerOptions>

protectedreadonly
redisClient : Redis

staticreadonly
STREAM_DATA_KEY :

protectedreadonly
streamReadClient : Redis

protectedreadonly
subscribedEvents : Set<string>

Methods

destroy() : Promise<void>

protected
emitEvent(
id: Buffer
group: string
event: string
data: unknown
) : void

protected
listen() : Promise<void>

publish<
Event extends keyof TEvents
>(
event: Event
data: TEvents[Event]
) : Promise<void>

Event extends keyof TEvents

unsubscribe(
events: (keyof TEvents)[]
) : Promise<void>

class PubSubRedisBroker

implements

extends

Table of contents

Properties

Methods

Type Parameters

TEvents extends Record<string, any>

Properties

protectedlistening : boolean

protectedreadonlyoptions : Required<RedisBrokerOptions>

protectedreadonlyredisClient : Redis

staticreadonlySTREAM_DATA_KEY :

protectedreadonlystreamReadClient : Redis

protectedreadonlysubscribedEvents : Set<string>

Methods

destroy() : Promise<void>

protected emitEvent(id: Buffergroup: stringevent: stringdata: unknown) : void

protected listen() : Promise<void>

publish<Event extends keyof TEvents>(event: Eventdata: TEvents[Event]) : Promise<void>

Event extends keyof TEvents

subscribe(events: (keyof TEvents)[]) : Promise<void>

unsubscribe(events: (keyof TEvents)[]) : Promise<void>

protected
listening : boolean

protectedreadonly
options : Required<RedisBrokerOptions>

protectedreadonly
redisClient : Redis

staticreadonly
STREAM_DATA_KEY :

protectedreadonly
streamReadClient : Redis

protectedreadonly
subscribedEvents : Set<string>

protected
emitEvent(
id: Buffer
group: string
event: string
data: unknown
) : void

protected
listen() : Promise<void>

publish<
Event extends keyof TEvents
>(
event: Event
data: TEvents[Event]
) : Promise<void>

subscribe(
events: (keyof TEvents)[]
) : Promise<void>

unsubscribe(
events: (keyof TEvents)[]
) : Promise<void>