Function: useOnEvents()

Call Signature

function useOnEvents<E>(handler: EventHandler<E>): void;

Defined in: src/wirestate-react/events/use-on-events.ts:25

Subscribes the component to every event on the active container's EventBus.

Type Parameters

Type Parameter	Default type
E extends WireEvent<unknown, EventType, unknown>	WireEvent<unknown, EventType, unknown>

Parameters

Parameter	Type	Description
handler	EventHandler<E>	Handler invoked for every event.

Returns

void

Throws

WirestateError if the active container cannot resolve EventBus.

Example

useOnEvents((event) => console.info(event.type));

Call Signature

function useOnEvents<E>(type: EventType, handler: EventHandler<E>): void;

Defined in: src/wirestate-react/events/use-on-events.ts:42

Subscribes the component to one event type on the active container's EventBus.

Type Parameters

Type Parameter	Default type
E extends WireEvent<unknown, EventType, unknown>	WireEvent<unknown, EventType, unknown>

Parameters

Parameter	Type	Description
type	EventType	Event type to listen for.
handler	EventHandler<E>	Handler invoked for matching events.

Returns

void

Throws

WirestateError if the active container cannot resolve EventBus.

Example

useOnEvents("CART_ITEM_ADDED", (event) => console.info(event.payload));

Call Signature

function useOnEvents<E>(types: readonly EventType[], handler: EventHandler<E>): void;

Defined in: src/wirestate-react/events/use-on-events.ts:59

Subscribes the component to several event types on the active container's EventBus.

Type Parameters

Type Parameter	Default type
E extends WireEvent<unknown, EventType, unknown>	WireEvent<unknown, EventType, unknown>

Parameters

Parameter	Type	Description
types	readonly EventType[]	Event types to listen for.
handler	EventHandler<E>	Handler invoked for matching events.

Returns

void

Throws

WirestateError if the active container cannot resolve EventBus.

Example

useOnEvents(["CART_ITEM_ADDED", "CART_VIEWED"], (event) => console.info(event.type));