packages/graphql-pubsub/src

Classes

Class	Description
GraphQLPubSubGlobalModule	-
GraphQLPubSubModule	Feature module that provides a RedisPubSub instance for use with GraphQL subscriptions.
GraphQLPubSubModuleCore	-
PubSubAsyncIterator	Async iterator for GraphQL subscriptions backed by a PubSubEngine.
RedisPubSub	Redis-backed implementation of the PubSubEngine contract.

Functions

Function	Description
InjectPubSub	Parameter decorator that injects the RedisPubSub instance registered under the GRAPHQL_PUBSUB token.

Interfaces

Interface	Description
AsyncIteratorOptions	Options for RedisPubSub.asyncIterator / PubSubAsyncIterator.
GraphQLPubSubModuleOptions	Options accepted by GraphQLPubSubModule.forRoot.
PubSubEngine	Core PubSub contract that RedisPubSub implements.
RedisPubSubOptions	Options for creating a RedisPubSub instance.
SubscriptionEvent	Metadata stored per active subscription.
SubscriptionOptions	Options passed when subscribing to a trigger.

Type Aliases

Type Alias	Description
MessageHandler	Callback invoked whenever a message arrives on a subscribed trigger.
SubscriptionMap	subId → SubscriptionEvent map.
SubsRefsMap	channel → [subId, …] map for fan-out dispatch.
TriggerTransform	A function that maps a trigger name (plus subscription options) to the Redis channel key that will actually be subscribed to.

Variables

Variable	Description
GRAPHQL_PUBSUB	DI token for the RedisPubSub instance. Use InjectPubSub for convenience.
GRAPHQL_PUBSUB_OPTIONS	DI token for the raw RedisPubSubOptions object.