Class: PubSubService

Constructors

constructor

• Private new PubSubService()

Defined in

src/service/pubsub.ts:18

Properties

server

• Private Optional server: Server

Defined in

src/service/pubsub.ts:16

---

client

▪ Static Protected client: PubSubClientV2

Defined in

src/service/pubsub.ts:12

---

driver

▪ Static Protected driver: "synchronous" | "google"

Defined in

src/service/pubsub.ts:14

---

instance

▪ Static Protected instance: PubSubService

Defined in

src/service/pubsub.ts:13

---

status

▪ Static Private status: "ready" | "pending" | "closed" = 'pending'

Defined in

src/service/pubsub.ts:15

Methods

bind

▸ Private bind(instance): void

Parameters

Name	Type
instance	PubSubService

Returns

void

Defined in

src/service/pubsub.ts:72

---

closeAll

▸ closeAll(): Promise<void>

Returns

Promise<void>

Defined in

src/service/pubsub.ts:133

---

getAllSubscriptions

▸ getAllSubscriptions(): Promise<AllSubscriptions[]>

Retrieves a list of subscribers

Returns

Promise<AllSubscriptions[]>

Defined in

src/service/pubsub.ts:219

---

getClient

▸ Private getClient(): PubSubClientV2

Returns

PubSubClientV2

Defined in

src/service/pubsub.ts:125

---

getSubscribers

▸ getSubscribers(): Subscribers

Returns

Subscribers

Defined in

src/service/pubsub.ts:129

---

initClient

▸ initClient(): void

Returns

void

Defined in

src/service/pubsub.ts:89

---

initDriver

▸ Private initDriver(): void

Returns

void

Defined in

src/service/pubsub.ts:77

---

publish

▸ publish<T, P>(topic, message, options): Promise<string>

Publishes new orders to PubSub.

Type parameters

Name	Type
T	extends Topic<T>
P	extends Payload

Parameters

Name	Type
topic	T
message	P
options	PublishOptions

Returns

Promise<string>

Defined in

src/service/pubsub.ts:107

---

shouldStartSynchronousSubscriptions

▸ Private shouldStartSynchronousSubscriptions(): boolean

Returns

boolean

Defined in

src/service/pubsub.ts:119

---

startServer

▸ Private startServer(): void

Returns

void

Defined in

src/service/pubsub.ts:25

---

startSubscriptions

▸ startSubscriptions(): Promise<void>

Returns

Promise<void>

Defined in

src/service/pubsub.ts:152

---

subscribe

▸ subscribe(subscription): Promise<void>

Subscribes to any given topic

Parameters

Name	Type
subscription	SubscriberTuple

Returns

Promise<void>

Defined in

src/service/pubsub.ts:212

---

syncDriverIsEnabled

▸ Private syncDriverIsEnabled(): boolean

Returns

boolean

Defined in

src/service/pubsub.ts:85

---

validate

▸ Protected validate<T, P>(topic, message): void

Validates Topic and Message according to validation rules set in Topic class

Type parameters

Name	Type
T	extends Topic<T>
P	extends Payload

Parameters

Name	Type	Description
topic	T	Topic
message	P	Message

Returns

void

Defined in

src/service/pubsub.ts:201

---

getInstance

▸ Static getInstance(): PubSubService

Returns

PubSubService

Defined in

src/service/pubsub.ts:97

---

isHealthy

▸ Static isHealthy(): boolean

Returns

boolean

Defined in

src/service/pubsub.ts:48