Skip to main content

PubSub

Admin Docs

Type Alias: PubSub

PubSub = object

Defined in: src/graphql/pubsub.ts:8

Type of the publish and subscribe module used for publishing and subscribing to talawa events.

Methods​

publish()​

publish<TKey>(event, callback?): void

Defined in: src/graphql/pubsub.ts:12

This method is used to publish an event.

Type Parameters​

TKey​

TKey extends `chats.${string}:chat_messages::create`

Parameters​

event​
payload​

PubSubPublishArgsByKey[TKey]

topic​

TKey

callback?​

() => void

Returns​

void

subscribe()​

subscribe<TKey>(topics): Promise<Readable & AsyncIterableIterator<PubSubPublishArgsByKey[TKey], any, any>>

Defined in: src/graphql/pubsub.ts:22

This method is used to subscribe to events.

Type Parameters​

TKey​

TKey extends `chats.${string}:chat_messages::create`

Parameters​

topics​

TKey | TKey[]

Returns​

Promise<Readable & AsyncIterableIterator<PubSubPublishArgsByKey[TKey], any, any>>