Class: SubscriptionService

Constructors

constructor

• new SubscriptionService()

Defined in

src/service/subscription.ts:23

Properties

defaultSubscriberOptions

▪ Static defaultSubscriberOptions: SubscriberOptions

All subscriptions will inherit from this default options object

Defined in

src/service/subscription.ts:21

---

subscribers

▪ Static subscribers: SubscriberObject<any>[] = []

Defined in

src/service/subscription.ts:14

Methods

closeAll

▸ Static closeAll(): Promise<void>

Call this function from a process exit handler to close all current subscriptions

Returns

Promise<void>

Defined in

src/service/subscription.ts:64

---

getSubscribers

▸ Static getSubscribers(): Subscribers

Returns

Subscribers

Defined in

src/service/subscription.ts:68

---

handleError

▸ Static handleError(error, metadata): void

If passed, it would serve as the default error handler for all subscriptions. Applications should override this with custom error handling: log error, cleanup resources and exit the process. Default logs the error and rethrows

Parameters

Name	Type
error	Error
metadata	SubscriberMetadata

Returns

void

Defined in

src/service/subscription.ts:51

---

init

▸ Static init(): Promise<void>

Can be used to initialize process level globals (like DB Connections). Default is a no-op

Returns

Promise<void>

Defined in

src/service/subscription.ts:42

---

loadSubscriptionService

▸ Static loadSubscriptionService(): typeof SubscriptionService

Returns

typeof SubscriptionService

Defined in

src/service/subscription.ts:112