InterPluginEventsAPI
Defined in: namespaces.ts:1078
Methods
Section titled “Methods”declareEvent()
Section titled “declareEvent()”declareEvent(
eventName,schema?):Promise<string>
Defined in: namespaces.ts:1080
Declares an inter-plugin event channel.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
schema?
Section titled “schema?”Record<string, unknown>
Returns
Section titled “Returns”Promise<string>
emit()
Section titled “emit()”emit(
eventName,payload):Promise<void>
Defined in: namespaces.ts:1082
Emits an event on a declared channel.
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
payload
Section titled “payload”unknown
Returns
Section titled “Returns”Promise<void>
subscribe()
Section titled “subscribe()”subscribe(
qualifiedEventName,handler):Promise<string>
Defined in: namespaces.ts:1084
Subscribes to an inter-plugin event.
Parameters
Section titled “Parameters”qualifiedEventName
Section titled “qualifiedEventName”string
handler
Section titled “handler”(payload) => void
Returns
Section titled “Returns”Promise<string>
unsubscribe()
Section titled “unsubscribe()”unsubscribe(
token):Promise<void>
Defined in: namespaces.ts:1086
Unsubscribes from an inter-plugin event.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>