emit

emit<T, K>(topic, value, instanceID?): void

Defined in: astrobase/src/events/events.ts:42

Emits an event. While this is a public API, This should generally only be called for custom topics. See the module overview of Events for more on custom topics.

Experimental

This API should not be used in production and may be trimmed from a public release.

Type Parameters

T

T extends Topics = Topics

A map of topic names and their emitted value types.

K

K extends string | number | symbol = keyof T

The topic name for this emitted event.

Parameters

topic

K

The topic name for this emitted event.

value

T[K]

The emitted value.

instanceID?

string

The instance that the event occurred within.

Returns

void