EnhancedSignal
Defined in: src/EnhancedAbortController.ts:11
The signal of an EnhancedAbortController: a real AbortSignal, with a few extras.
Extends
Section titled “Extends”AbortSignal
Properties
Section titled “Properties”aborted
Section titled “aborted”
readonlyaborted:boolean
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2752
The aborted read-only property returns a value that indicates whether the asynchronous operations the signal is communicating with are aborted (true) or not (false).
Inherited from
Section titled “Inherited from”AbortSignal.aborted
canBeAborted
Section titled “canBeAborted”
readonlycanBeAborted:boolean
Defined in: src/EnhancedAbortController.ts:17
Always true for a controller’s signal (see EnhancedAbortSignal.canBeAborted).
onabort
Section titled “onabort”onabort: ((
this,ev) =>any) |null
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2754
Inherited from
Section titled “Inherited from”AbortSignal.onabort
reason
Section titled “reason”
readonlyreason:any
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2760
The reason read-only property returns a JavaScript value that indicates the abort reason.
Inherited from
Section titled “Inherited from”AbortSignal.reason
whenAborted
Section titled “whenAborted”
readonlywhenAborted:Promise<unknown>
Defined in: src/EnhancedAbortController.ts:15
Same as whenAborted(signal): resolves with the reason once the signal aborts.
Methods
Section titled “Methods”addEventListener()
Section titled “addEventListener()”Call Signature
Section titled “Call Signature”addEventListener<
K>(type,listener,options?):void
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2767
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Type Parameters
Section titled “Type Parameters”K extends "abort"
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”AbortSignal.addEventListener
Call Signature
Section titled “Call Signature”addEventListener(
type,listener,options?):void
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2768
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”AbortSignal.addEventListener
dispatchEvent()
Section titled “dispatchEvent()”dispatchEvent(
event):boolean
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:11575
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.
Parameters
Section titled “Parameters”Event
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”AbortSignal.dispatchEvent
register()
Section titled “register()”register(
callback):AbortRegistration
Defined in: src/EnhancedAbortController.ts:13
Same as register(signal, callback).
Parameters
Section titled “Parameters”callback
Section titled “callback”(reason) => void
Returns
Section titled “Returns”removeEventListener()
Section titled “removeEventListener()”Call Signature
Section titled “Call Signature”removeEventListener<
K>(type,listener,options?):void
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2769
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Type Parameters
Section titled “Type Parameters”K extends "abort"
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(this, ev) => any
options?
Section titled “options?”boolean | EventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”AbortSignal.removeEventListener
Call Signature
Section titled “Call Signature”removeEventListener(
type,listener,options?):void
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2770
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.
Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | EventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”AbortSignal.removeEventListener
throwIfAborted()
Section titled “throwIfAborted()”throwIfAborted():
void
Defined in: site/node_modules/typescript/lib/lib.dom.d.ts:2766
The throwIfAborted() method throws the signal’s abort AbortSignal.reason if the signal has been aborted; otherwise it does nothing.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”AbortSignal.throwIfAborted