PubSubRedisBroker
PubSub broker powered by Redis
Example
Extends
BaseRedisBroker<TEvents>Implements
IPubSubBroker<TEvents>Name | Constraints | Optional | Default | Description |
---|---|---|---|---|
TEvents | Record<string, any> | No | None |
Whether this broker is currently polling events
Inherited from BaseRedisBrokerProtectedReadonly
Options this broker is using
Inherited from BaseRedisBrokerUsed for Redis queues, see the 3rd argument taken by xadd
Inherited from BaseRedisBrokerProtectedReadonly
Internal copy of the Redis client being used to read incoming payloads
Inherited from BaseRedisBrokerProtectedReadonly
Events this broker has subscribed to
Inherited from BaseRedisBrokerDestroys the broker, closing all connections
Inherited from BaseRedisBrokerName | Type | Optional | Description |
---|---|---|---|
id | Buffer | No | None |
group | string | No | None |
event | string | No | None |
data | unknown | No | None |
Protected
Begins polling for events, firing them to listen
Name | Type | Optional | Description |
---|---|---|---|
group | string | No | None |
Publishes an event
Name | Constraints | Optional | Default | Description |
---|---|---|---|---|
T | keyof TEvents | No | None |
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 |
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 |