Skip to content

@ralphschuler.logger.Logger.<internal>.AbortSignal

github-actions edited this page Nov 26, 2023 · 1 revision

Interface: AbortSignal

Logger.<internal>.AbortSignal

A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.

Hierarchy

Table of contents

Properties

Methods

Properties

aborted

Readonly aborted: boolean

Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.

Defined in

node_modules/@types/node/globals.d.ts:64


onabort

onabort: null | (this: AbortSignal, event: Event) => any

Defined in

node_modules/@types/node/globals.d.ts:66


reason

Readonly reason: any

Defined in

node_modules/@types/node/globals.d.ts:65

Methods

addEventListener

addEventListener(type, listener, options?): void

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

If the once option is true, the listener is removed after the next time a type event is dispatched.

The capture option is not used by Node.js in any functional way other than tracking registered event listeners per the EventTarget specification. Specifically, the capture option is used as part of the key when registering a listener. Any individual listener may be added once with capture = false, and once with capture = true.

Parameters

Name Type
type string
listener EventListener | EventListenerObject
options? boolean | AddEventListenerOptions

Returns

void

Inherited from

EventTarget.addEventListener

Defined in

node_modules/@types/node/dom-events.d.ts:61


dispatchEvent

dispatchEvent(event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters

Name Type
event Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

Defined in

node_modules/@types/node/dom-events.d.ts:67


removeEventListener

removeEventListener(type, listener, options?): void

Removes the event listener in target's event listener list with the same type, callback, and options.

Parameters

Name Type
type string
listener EventListener | EventListenerObject
options? boolean | EventListenerOptions

Returns

void

Inherited from

EventTarget.removeEventListener

Defined in

node_modules/@types/node/dom-events.d.ts:69


throwIfAborted

throwIfAborted(): void

Returns

void

Defined in

node_modules/@types/node/globals.d.ts:67

Typescript Libraries

Modules

Namespaces

Clone this wiki locally