Interface: PubSubEngine

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

Core PubSub contract that RedisPubSub implements.

Methods

asyncIterator()

asyncIterator<T>(triggers, options?): AsyncIterator<T>;

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
triggers	string | string[]
options?	AsyncIteratorOptions

Returns

AsyncIterator<T>

---

publish()

publish(triggerName, payload): Promise<void>;

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

Parameters

Parameter	Type
triggerName	string
payload	unknown

Returns

Promise<void>

---

subscribe()

subscribe(
   triggerName, 
   onMessage, 
   options?
): Promise<number>;

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

Parameters

Parameter	Type
triggerName	string
onMessage	MessageHandler
options?	SubscriptionOptions

Returns

Promise<number>

---

unsubscribe()

unsubscribe(subId): void;

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

Parameters

Parameter	Type
subId	number

Returns

void