Class: BasePublisher<E>

Defined in: src/sdk/instruments/BasePublishers.ts:8

A basic event-bus publisher.

Extended by

• SystemAlertPublisher
• VNavControlEventPublisher
• VNavDataEventPublisher
• HEventPublisher
• StallWarningPublisher
• ControlPublisher
• RandomNumberPublisher
• SimVarPublisher
• GameVarPublisher
• ClockPublisher
• GNSSPublisher
• BaseInstrumentPublisher

Type Parameters

Type Parameter
E extends Record<string, any>

Constructors

Constructor

new BasePublisher<E>(bus, pacer): BasePublisher<E>

Defined in: src/sdk/instruments/BasePublishers.ts:20

Creates an instance of BasePublisher.

Parameters

Parameter	Type	Default value	Description
bus	EventBus	undefined	The common event bus.
pacer	undefined | PublishPacer<E>	undefined	An optional pacer to control the rate of publishing.

Returns

BasePublisher<E>

Properties

bus

protected readonly bus: EventBus

Defined in: src/sdk/instruments/BasePublishers.ts:10

---

pacer

protected readonly pacer: undefined | PublishPacer<E>

Defined in: src/sdk/instruments/BasePublishers.ts:13

---

publishActive

protected publishActive: boolean

Defined in: src/sdk/instruments/BasePublishers.ts:12

---

publisher

protected readonly publisher: Publisher<E>

Defined in: src/sdk/instruments/BasePublishers.ts:11

Methods

isPublishing()

isPublishing(): boolean

Defined in: src/sdk/instruments/BasePublishers.ts:45

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

---

onUpdate()

onUpdate(): void

Defined in: src/sdk/instruments/BasePublishers.ts:52

A callback called when the publisher receives an update cycle.

Returns

void

---

publish()

protected publish<K>(topic, data, sync, isCached): void

Defined in: src/sdk/instruments/BasePublishers.ts:63

Publish a message if publishing is acpive

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type	Default value	Description
topic	K	undefined	The topic key to publish to.
data	E[K]	undefined	The data type for chosen topic.
sync	boolean	false	Whether or not the event should be synced to other instruments. Defaults to false.
isCached	boolean	true	Whether or not the event should be cached. Defaults to true.

Returns

void

---

startPublish()

startPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:30

Start publishing.

Returns

void

---

stopPublish()

stopPublish(): void

Defined in: src/sdk/instruments/BasePublishers.ts:37

Stop publishing.

Returns

void