Scripting API / core/GSEventListener
core/GSEventListener
Classes
abstract GSEventListener
Extended by
DashboardListenerDashboardItemListenerAlsoRetrieveListenerRetrievalListenerGlobalTagAreaListenerInspectionListenerSubInspectionListenerTestListener
Type Parameters
| Type Parameter |
|---|
OptionsType |
EventType extends string |
Methods
addEventListener()
addEventListener(
eventType,handler):ScriptEventSubscription
Binds the given function to an event fired by one or more sub-inspections. Returns a GUID that can be used to remove the added event
Parameters
| Parameter | Type | Description |
|---|---|---|
eventType |
EventType |
Type of event to bind to (e.g. 'afterStart'). Valid types are determined by the EventType generic. |
handler |
EventHandler<OptionsType> |
- |
Returns
Type Aliases
ScriptEventSubscription
ScriptEventSubscription =
object
An object which may be used to unsubscribe a function from an event.
Properties
| Property | Type |
|---|---|
stopListening |
() => void |