Interface: RedisPubSubOptions

Defined in: packages/graphql-pubsub/src/interfaces.ts:4

Options for creating a RedisPubSub instance.

Properties

Property	Type	Description	Defined in
connection?	RedisOptions	ioredis connection options used when publisher/subscriber are not provided.	packages/graphql-pubsub/src/interfaces.ts:15
connectionListener?	(err) => void	Called when the publisher/subscriber connections are established or fail. undefined is passed on successful connect, an Error on failure.	packages/graphql-pubsub/src/interfaces.ts:20
deserializer?	(payload) => unknown	Custom deserializer for incoming message payloads. Defaults to JSON.parse.	packages/graphql-pubsub/src/interfaces.ts:32
keyPrefix?	string	Key prefix prepended to every Redis channel name.	packages/graphql-pubsub/src/interfaces.ts:6
publisher?	Redis	Pre-existing Redis client used for publishing.	packages/graphql-pubsub/src/interfaces.ts:8
reviver?	(key, value) => unknown	Optional JSON reviver function passed to JSON.parse when deserialising incoming messages (used only when deserializer is not provided).	packages/graphql-pubsub/src/interfaces.ts:28
serializer?	(payload) => string	Custom serializer for outgoing message payloads. Defaults to JSON.stringify.	packages/graphql-pubsub/src/interfaces.ts:30
subscriber?	Redis	Pre-existing Redis client used for subscribing.	packages/graphql-pubsub/src/interfaces.ts:10
triggerTransform?	TriggerTransform	Transforms a trigger name before it is used as the Redis channel key.	packages/graphql-pubsub/src/interfaces.ts:22