Skip to content

Interface: AbortSignal ​

Defined in: types/desktop-engine.d.ts:4075

addEventListener / removeEventListener / dispatchEvent with typed events

Extends ​

Properties ​

aborted ​

ts
readonly aborted: boolean;

Defined in: types/desktop-engine.d.ts:4076


onabort ​

ts
onabort: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4078


reason ​

ts
readonly reason: any;

Defined in: types/desktop-engine.d.ts:4077

Methods ​

addEventListener() ​

ts
addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:3810

Type Parameters ​

Type Parameter
K extends "abort"

Parameters ​

ParameterType
typeK
listener(this, event) => void
options?AddEventListenerOptions

Returns ​

void

Inherited from ​

EventTarget.addEventListener


dispatchEvent() ​

ts
dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3813

Returns false when a listener called preventDefault() on a cancelable event

Parameters ​

ParameterType
eventEvent

Returns ​

boolean

Inherited from ​

EventTarget.dispatchEvent


removeEventListener() ​

ts
removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:3811

Type Parameters ​

Type Parameter
K extends "abort"

Parameters ​

ParameterType
typeK
listener(this, event) => void

Returns ​

void

Inherited from ​

EventTarget.removeEventListener


throwIfAborted() ​

ts
throwIfAborted(): void;

Defined in: types/desktop-engine.d.ts:4080

Throws reason when aborted

Returns ​

void

The SDK is released under the Apache License 2.0