HandlerRegistry
Defined in: packages/handlers/src/index.ts:2
A typed handler registry for Lunibee events.
Type Parameters
Section titled “Type Parameters”Events
Section titled “Events”Events extends { [K in keyof Events]: unknown[] }
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new HandlerRegistry<
Events>():HandlerRegistry<Events>
Returns
Section titled “Returns”HandlerRegistry<Events>
Methods
Section titled “Methods”dispatch()
Section titled “dispatch()”dispatch<
K>(event, …args):Promise<void>
Defined in: packages/handlers/src/index.ts:37
Dispatches an event to registered handlers.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event key.
…Events[K]
Event arguments.
Returns
Section titled “Returns”Promise<void>
A promise fulfilled after handlers complete.
emit()
Section titled “emit()”emit<
K>(event, …args):Promise<void>
Defined in: packages/handlers/src/index.ts:53
Emits an event using the conventional emitter name.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event key.
…Events[K]
Event arguments.
Returns
Section titled “Returns”Promise<void>
A promise fulfilled after handlers complete.
off<
K>(event,handler):this
Defined in: packages/handlers/src/index.ts:29
Removes a handler.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event key.
handler
Section titled “handler”(…args) => unknown
Handler callback.
Returns
Section titled “Returns”this
This registry.
on<
K>(event,handler):this
Defined in: packages/handlers/src/index.ts:10
Registers a handler for an event.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event key.
handler
Section titled “handler”(…args) => unknown
Handler callback.
Returns
Section titled “Returns”this
This registry.
once()
Section titled “once()”once<
K>(event,handler):this
Defined in: packages/handlers/src/index.ts:18
Registers a one-shot handler.
Type Parameters
Section titled “Type Parameters”K extends string | number | symbol
Parameters
Section titled “Parameters”K
Event key.
handler
Section titled “handler”(…args) => unknown
Handler callback.
Returns
Section titled “Returns”this
This registry.