Interface PubSubService

interface PubSubService {
    connect(): Promise<void>;
    disconnect(): Promise<void>;
    publish<
        P extends PublicationName,
        C extends HookMessageContent | ModelEventMessageContent,
    >(
        publicationName: P,
        messageContent: C,
        options?: PublishOptions,
    ): Promise<Publication>;
    subscribe<
        S extends SubscriptionName,
        C extends HookMessageContent | ModelEventMessageContent,
    >(
        subscriptionName: S,
        handler: MessageHandler<C>,
    ): Promise<services.pubsub.Subscription>;
}

Index

Methods

connect disconnect publish subscribe

Methods

connect

connect(): Promise<void>
Connects to the pub/sub service

Returns Promise<void>
- Defined in packages/services/src/services/PubSub/PubSubService.ts:18

disconnect

disconnect(): Promise<void>
Disconnects from the pub/sub service

Returns Promise<void>
- Defined in packages/services/src/services/PubSub/PubSubService.ts:51

publish

publish<
    P extends PublicationName,
    C extends HookMessageContent | ModelEventMessageContent,
>(
    publicationName: P,
    messageContent: C,
    options?: PublishOptions,
): Promise<Publication>
Publishes a message to a topic
Type Parameters
- P extends PublicationName
- C extends HookMessageContent | ModelEventMessageContent
Parameters
- publicationName: P
  The name of the publication to publish to
- messageContent: C
  The content of the message to publish
- Optionaloptions: PublishOptions
  Additional options for the publication
Returns Promise<Publication>
- Defined in packages/services/src/services/PubSub/PubSubService.ts:26

subscribe

subscribe<
    S extends SubscriptionName,
    C extends HookMessageContent | ModelEventMessageContent,
>(
    subscriptionName: S,
    handler: MessageHandler<C>,
): Promise<services.pubsub.Subscription>
Subscribes to a topic
Type Parameters
- S extends SubscriptionName
- C extends HookMessageContent | ModelEventMessageContent
Parameters
- subscriptionName: S
  The name of the subscription to subscribe to
- handler: MessageHandler<C>
  The handler for messages received on the subscription
Returns Promise<services.pubsub.Subscription>
- Defined in packages/services/src/services/PubSub/PubSubService.ts:40