Scripting API / inspection/tests/TestListener / External

External

Classes

abstract AcknowledgeEventData

Extends

• ThreadEventData

Extended by

• WorkerToMainAcknowledgeData

Properties

Property	Type	Default value	Description	Overrides	Inherited from
acknowledged	boolean	true	Whether this is an original message or an acknowledgement	ThreadEventData.acknowledged	-
data	any	undefined	Additional data to send	-	ThreadEventData.data
error?	object	undefined	If present, then an error occurred in another context, and it needs to be handled	-	ThreadEventData.error
error.fileGuid?	string	undefined	-	-	-
error.message	string	undefined	-	-	-
error.stack?	string	undefined	-	-	-
guid	string	undefined	Event GUID used to look up event promises to resolve	-	ThreadEventData.guid
transferData?	any[]	undefined	If set, this data will be transferred between threads, instead of copied. For more info see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects	-	ThreadEventData.transferData

---

abstract ThreadEventData

Extended by

• AcknowledgeEventData

Properties

Property	Type	Description
acknowledged	boolean	Whether this is an original message or an acknowledgement
data	any	Additional data to send
error?	object	If present, then an error occurred in another context, and it needs to be handled
error.fileGuid?	string	-
error.message	string	-
error.stack?	string	-
guid	string	Event GUID used to look up event promises to resolve
transferData?	any[]	If set, this data will be transferred between threads, instead of copied. For more info see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects

---

WorkerToMainAcknowledgeData

Acknowledgements

Extends

• AcknowledgeEventData

Properties

Property	Modifier	Type	Default value	Description	Inherited from
acknowledged	public	boolean	true	Whether this is an original message or an acknowledgement	AcknowledgeEventData.acknowledged
data	public	any	undefined	Additional data to send	AcknowledgeEventData.data
error?	public	object	undefined	If present, then an error occurred in another context, and it needs to be handled	AcknowledgeEventData.error
error.fileGuid?	public	string	undefined	-	-
error.message	public	string	undefined	-	-
error.stack?	public	string	undefined	-	-
guid	public	string	undefined	Event GUID used to look up event promises to resolve	AcknowledgeEventData.guid
transferData?	public	any[]	undefined	If set, this data will be transferred between threads, instead of copied. For more info see https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Transferable_objects	AcknowledgeEventData.transferData

Type Aliases

EventHandler

EventHandler<T> = object

Type Parameters

Type Parameter
T

Properties

Property	Type
fn	(event) => Promise<void> | void
options	T

---

TestEventType

TestEventType = "focusIn" | "focusOut" | "optionSelected" | "click" | "rtfChanged" | "pagination"

---

TriggeredEventData

TriggeredEventData<T> = object

** Event Binding Events are triggered on the main thread and sent to the worker thread. The worker thread can subscribe to those events.

The format of the events is as follows: { type: API which the event is fired on (e.g. triggerSubInspectionEvent) data: TriggeredEventData - Data for the event triggered { eventType: The specific event to fire (e.g. 'afterStart') event: A ScriptEvent object which is passed into the the subscribed handlers { data: Defined by the specific event } } }

---

Type Parameters

Type Parameter
T

Properties

Property	Type
event	ScriptEvent
eventType	T