Version: v2
Class: PubSubService
Properties#
client#
â–ª Static Protected client: PubSubClientV2
Defined in#
driver#
â–ª Static Protected driver: "synchronous" | "google"
Defined in#
instance#
â–ª Static Protected instance: PubSubService
Defined in#
Methods#
closeAll#
â–¸ closeAll(): Promise<void>
Returns#
Promise<void>
Defined in#
getAllSubscriptions#
â–¸ getAllSubscriptions(): Promise<AllSubscriptions[]>
Retrieves a list of subscribers
Returns#
Promise<AllSubscriptions[]>
Defined in#
getSubscribers#
â–¸ getSubscribers(): Subscribers
Returns#
Subscribers
Defined in#
initClient#
â–¸ initClient(): void
Returns#
void
Defined in#
publish#
â–¸ publish<T>(topic, message, options?): Promise<string>
Publishes new orders to PubSub.
Type parameters#
| Name | Type | 
|---|---|
T | extends TopicProperties | 
Parameters#
| Name | Type | 
|---|---|
topic | T | 
message | Record<string, unknown> | 
options? | PublishOptions | 
Returns#
Promise<string>
Defined in#
startSubscriptions#
â–¸ startSubscriptions(): Promise<void>
Returns#
Promise<void>
Defined in#
subscribe#
â–¸ subscribe(subscription): Promise<void>
Subscribes to any given topic
Parameters#
| Name | Type | 
|---|---|
subscription | SubscriberTuple | 
Returns#
Promise<void>
Defined in#
getInstance#
â–¸ Static getInstance(): PubSubService
Returns#
Defined in#
isHealthy#
â–¸ Static isHealthy(): boolean
Returns#
boolean