Skip to main content

registerEventHandler()

function registerEventHandler(
   eventName: string, 
   handler: (...args: unknown[]) => void, 
   register: RegisterFn, 
   remove?: RemoveFn, 
   source?: string): IDisposable;

Defined in: src/lib/events/helpers.ts:84

Registers an event handler and returns a disposable for cleanup. Works with both local (on) and network (onNet) events. Automatically tracks the registration for debugging purposes.

Parameters

ParameterTypeDescription
eventNamestringThe event name to listen to.
handler(...args: unknown[]) => voidThe wrapped handler function.
registerRegisterFnThe registration function (on or onNet).
remove?RemoveFnOptional removal function (e.g., RemoveEventHandler).
source?stringOptional source identifier for tracking (e.g., module name).

Returns

IDisposable

A disposable that removes the event listener when disposed.