Skip to content

Kiln API / kiln / Events

Interface: Events ​

Per-system view of the event bus: events.read(Hit), events.emit(Hit, {...}).

Methods ​

read() ​

ts
read<T>(e): readonly T[];

Events of this type this reader hasn't seen yet. The array is reused; copy it to keep it.

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
eEventType<T>

Returns ​

readonly T[]


emit() ​

ts
emit<T>(e, ...data): void;

Type Parameters ​

Type Parameter
T

Parameters ​

ParameterType
eEventType<T>
...dataT extends void ? [] : [T]

Returns ​

void