Class: HEventPublisher

A publisher for publishing H:Events on the bus.

Hierarchy

• BasePublisher<HEvent>

  ↳ HEventPublisher

Constructors

constructor

• new HEventPublisher(bus, pacer?): HEventPublisher

Creates an instance of BasePublisher.

Parameters

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

Returns

HEventPublisher

Inherited from

BasePublisher.constructor

Defined in

src/sdk/instruments/BasePublishers.ts:20

Properties

bus

• Protected Readonly bus: EventBus

Inherited from

BasePublisher.bus

Defined in

src/sdk/instruments/BasePublishers.ts:10

---

pacer

• Protected Readonly pacer: undefined | PublishPacer<HEvent>

Inherited from

BasePublisher.pacer

Defined in

src/sdk/instruments/BasePublishers.ts:13

---

publishActive

• Protected publishActive: boolean

Inherited from

BasePublisher.publishActive

Defined in

src/sdk/instruments/BasePublishers.ts:12

---

publisher

• Protected Readonly publisher: Publisher<HEvent>

Inherited from

BasePublisher.publisher

Defined in

src/sdk/instruments/BasePublishers.ts:11

Methods

dispatchHEvent

▸ dispatchHEvent(hEvent, sync?): void

Dispatches an H:Event to the event bus.

Parameters

Name	Type	Default value	Description
hEvent	string	undefined	The H:Event to dispatch.
sync	boolean	false	Whether this event should be synced (optional, default false)

Returns

void

Defined in

src/sdk/data/HEventPublisher.ts:20

---

isPublishing

▸ isPublishing(): boolean

Tells whether or not the publisher is currently active.

Returns

boolean

True if the publisher is active, false otherwise.

Inherited from

BasePublisher.isPublishing

Defined in

src/sdk/instruments/BasePublishers.ts:45

---

onUpdate

▸ onUpdate(): void

A callback called when the publisher receives an update cycle.

Returns

void

Inherited from

BasePublisher.onUpdate

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 "hEvent"

Parameters

Name	Type	Default value	Description
topic	K	undefined	The topic key to publish to.
data	HEvent[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

Inherited from

BasePublisher.publish

Defined in

src/sdk/instruments/BasePublishers.ts:63

---

startPublish

▸ startPublish(): void

Start publishing.

Returns

void

Inherited from

BasePublisher.startPublish

Defined in

src/sdk/instruments/BasePublishers.ts:30

---

stopPublish

▸ stopPublish(): void

Stop publishing.

Returns

void

Inherited from

BasePublisher.stopPublish

Defined in

src/sdk/instruments/BasePublishers.ts:37