parsifly-extension-base / index / EventLink

Class: EventLink

Defined in: lib/shared/services/EventLink.ts:14

Async bridge between this extension and the studio

Methods

callStudioEvent()

callStudioEvent<GParams, GReturn>(key, ...params): Promise<GReturn>

Defined in: lib/shared/services/EventLink.ts:53

Call a async event at the studio can return a value on resolve

Type Parameters

GParams

GParams = unknown

GReturn

GReturn = unknown

Parameters

key

string

Event key to be called

params

...GParams[]

Params to be forward to studio

Returns

Promise<GReturn>

removeExtensionEvent()

removeExtensionEvent(key): void

Defined in: lib/shared/services/EventLink.ts:43

Remove a event listener from the studio

Parameters

key

string

Event key to be removed

Returns

void

setExtensionEvent()

setExtensionEvent<GParams, GReturn>(key, event): void

Defined in: lib/shared/services/EventLink.ts:36

Register a async event listener to be called by the studio

Type Parameters

GParams

GParams = unknown

GReturn

GReturn = unknown

Parameters

key

string

Key of the event to be registered

event

TEvent<GParams, GReturn>

Async event to be called by the studio

Returns

void

callStudioEvent()

static callStudioEvent<GParams, GReturn>(key, ...params): Promise<GReturn>

Defined in: lib/shared/services/EventLink.ts:81

Call a async event at the studio can return a value on resolve

Type Parameters

GParams

GParams = unknown

GReturn

GReturn = unknown

Parameters

key

string

Event key to be called

params

...GParams[]

Params to be forward to studio

Returns

Promise<GReturn>

removeExtensionEvent()

static removeExtensionEvent(key): void

Defined in: lib/shared/services/EventLink.ts:71

Remove a event listener from the studio

Parameters

key

string

Event key to be removed

Returns

void

setExtensionEvent()

static setExtensionEvent<GParams, GReturn>(key, event): void

Defined in: lib/shared/services/EventLink.ts:64

Register a async event listener to be called by the studio

Type Parameters

GParams

GParams = unknown

GReturn

GReturn = unknown

Parameters

key

string

Key of the event to be registered

event

TEvent<GParams, GReturn>

Async event to be called by the studio

Returns

void