Documentation / Listeners / Listener

Listener()<T>

type Listener<T> = (currentLocalState) => boolean | void | Promise<void>;

Defined in: Listeners.ts:16

A listener function that is called when an event is broadcast.

The listener can return true to remove itself from the listener set, false to keep itself in the listener set, or void to keep itself in the listener set.

Type Parameters

T

T

Parameters

currentLocalState

T

Returns

boolean | void | Promise<void>

Examples

() => true // remove listener
() => false // keep listener
() => {} // keep listener

({a, b}) => console.log(a, b)