Class: BasePublisher<E>

A basic event-bus publisher.

Type parameters

Name	Type
E	extends Record<string, any>

Hierarchy

• BasePublisher

  ↳ SystemAlertPublisher

  ↳ VNavControlEventPublisher

  ↳ VNavDataEventPublisher

  ↳ HEventPublisher

  ↳ StallWarningPublisher

  ↳ ControlPublisher

  ↳ RandomNumberPublisher

  ↳ SimVarPublisher

  ↳ GameVarPublisher

  ↳ ClockPublisher

  ↳ GNSSPublisher

  ↳ BaseInstrumentPublisher

Constructors

constructor

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

Creates an instance of BasePublisher.

Type parameters

Name	Type
E	extends Record<string, any>

Parameters

Name	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>

Defined in

src/sdk/instruments/BasePublishers.ts:20

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

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

Defined in

src/sdk/instruments/BasePublishers.ts:45

---

onUpdate

▸ onUpdate(): void

A callback called when the publisher receives an update cycle.

Returns

void

Defined in

src/sdk/instruments/BasePublishers.ts:52

---

publish

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

Publish a message if publishing is acpive

Type parameters

Name	Type
K	extends string | number | symbol

Parameters

Name	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

Defined in

src/sdk/instruments/BasePublishers.ts:63

---

startPublish

▸ startPublish(): void

Start publishing.

Returns

void

Defined in

src/sdk/instruments/BasePublishers.ts:30

---

stopPublish

▸ stopPublish(): void

Stop publishing.

Returns

void

Defined in

src/sdk/instruments/BasePublishers.ts:37