Interface: GraphQLPubSubModuleOptions
Defined in: packages/graphql-pubsub/src/graphql-pubsub.module.ts:19
Options accepted by GraphQLPubSubModule.forRoot.
Exactly one of useValue, useExisting, or useFactory should be provided.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
isGlobal? | boolean | When true (default) the module is registered globally and the GRAPHQL_PUBSUB token is available application-wide without importing this module in every feature module. | packages/graphql-pubsub/src/graphql-pubsub.module.ts:43 |
useExisting? | { keyPrefix?: string; publisher: Redis; subscriber: Redis; } | Pre-created publisher and subscriber Redis clients. Use this when you manage Redis connections outside of the module. | packages/graphql-pubsub/src/graphql-pubsub.module.ts:31 |
useExisting.keyPrefix? | string | - | packages/graphql-pubsub/src/graphql-pubsub.module.ts:34 |
useExisting.publisher | Redis | - | packages/graphql-pubsub/src/graphql-pubsub.module.ts:32 |
useExisting.subscriber | Redis | - | packages/graphql-pubsub/src/graphql-pubsub.module.ts:33 |
useFactory? | (...args) => | RedisPubSubOptions | Promise<RedisPubSubOptions> | Synchronous factory function that returns RedisPubSubOptions. Prefer GraphQLPubSubModule.forRootAsync when async config is needed. | packages/graphql-pubsub/src/graphql-pubsub.module.ts:24 |
useValue? | RedisPubSubOptions | Plain configuration object passed directly to RedisPubSub. | packages/graphql-pubsub/src/graphql-pubsub.module.ts:37 |