EventBus
Defined in: client/api.d.ts:2902
Asynchronous resource event bus. Native event names and callback payloads are inferred from EventMap. Script-defined event names remain supported by the string overloads.
Methods
Section titled “Methods”emit()
Section titled “emit()”emit(
eventName, …args):Promise<void>
Defined in: client/api.d.ts:2909
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”Promise<void>
emitLocal()
Section titled “emitLocal()”emitLocal(
eventName, …args):Promise<void>
Defined in: client/api.d.ts:2912
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”Promise<void>
emitTo()
Section titled “emitTo()”emitTo(
resourceName,eventName, …args):Promise<void>
Defined in: client/api.d.ts:2910
Parameters
Section titled “Parameters”resourceName
Section titled “resourceName”string
eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”Promise<void>
listenerCount()
Section titled “listenerCount()”listenerCount(
eventName):number
Defined in: client/api.d.ts:2916
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
Returns
Section titled “Returns”number
Call Signature
Section titled “Call Signature”off<
K>(eventName,handler):void
Defined in: client/api.d.ts:2907
Type Parameters
Section titled “Type Parameters”K extends keyof EventMap
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”off(
eventName,handler):void
Defined in: client/api.d.ts:2908
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
offClient()
Section titled “offClient()”offClient(
eventName,handler):void
Defined in: client/api.d.ts:2915
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”on<
K>(eventName,handler): () =>void
Defined in: client/api.d.ts:2903
Type Parameters
Section titled “Type Parameters”K extends keyof EventMap
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”() => void
Call Signature
Section titled “Call Signature”on(
eventName,handler): () =>void
Defined in: client/api.d.ts:2904
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”() => void
once()
Section titled “once()”Call Signature
Section titled “Call Signature”once<
K>(eventName,handler):void
Defined in: client/api.d.ts:2905
Type Parameters
Section titled “Type Parameters”K extends keyof EventMap
Parameters
Section titled “Parameters”eventName
Section titled “eventName”K
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
Call Signature
Section titled “Call Signature”once(
eventName,handler):void
Defined in: client/api.d.ts:2906
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
onceClient()
Section titled “onceClient()”onceClient(
eventName,handler):void
Defined in: client/api.d.ts:2914
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void
onClient()
Section titled “onClient()”onClient(
eventName,handler): () =>void
Defined in: client/api.d.ts:2913
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”() => void
onLocal()
Section titled “onLocal()”onLocal(
eventName,handler):void
Defined in: client/api.d.ts:2911
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
handler
Section titled “handler”(…args) => unknown
Returns
Section titled “Returns”void