Data shape Client API
EventBus
interface EventBus { emit ( eventName : string , ... args : unknown [] ) : Promise < void > ; emitLocal ( eventName : string , ... args : unknown [] ) : Promise < void > ; emitTo ( resourceName : string , eventName : string , ... args : unknown [] , ) : Promise < void > ; listenerCount ( eventName : string ) : number ; off < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : void ; off ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void ; offClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown , ) : void ; on < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : () => void ; on ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : () => void ; once < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : void ; once ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void ; onceClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown , ) : void ; onClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown , ) : () => void ; onLocal ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void ; }
Methods
emit
emit ( eventName : string , ... args : unknown [] ) : Promise < void >
Parameters
eventName : string
... args : unknown []
Returns Promise < void >
emit Local
emitLocal ( eventName : string , ... args : unknown [] ) : Promise < void >
Parameters
eventName : string
... args : unknown []
Returns Promise < void >
emit To
emitTo ( resourceName : string , eventName : string , ... args : unknown [] , ) : Promise < void >
Parameters
resourceName : string
eventName : string
... args : unknown []
Returns Promise < void >
listener Count
listenerCount ( eventName : string ) : number
off
off < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : void
Parameters
eventName : K
handler : ( ... args : EventMap [ K ] ) => unknown
Returns void
off ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns void
off Client
offClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns void
on
on < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : () => void
Parameters
eventName : K
handler : ( ... args : EventMap [ K ] ) => unknown
Returns () => void
on ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : () => void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns () => void
once
once < K extends keyof EventMap > ( eventName : K , handler : ( ... args : EventMap [ K ] ) => unknown , ) : void
Parameters
eventName : K
handler : ( ... args : EventMap [ K ] ) => unknown
Returns void
once ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns void
once Client
onceClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns void
on Client
onClient ( eventName : string , handler : ( ... args : unknown [] ) => unknown , ) : () => void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns () => void
on Local
onLocal ( eventName : string , handler : ( ... args : unknown [] ) => unknown ) : void
Parameters
eventName : string
handler : ( ... args : unknown [] ) => unknown
Returns void
Asynchronous resource event bus. Native event names and callback payloads are inferred from EventMap. Script-defined event names remain supported by the string overloads.