Skip to content

@ralphschuler.ai function caller.index.<internal>.AbortSignal

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

Interface: AbortSignal

index.<internal>.AbortSignal

A signal object that allows you to communicate with a request and abort it if required via its associated AbortController object.

Remarks

This interface is compatible with the AbortSignal interface defined in TypeScript's DOM types. It is redefined here, so it can be polyfilled without a DOM, for example with abortcontroller-polyfill in a Node environment.

Table of contents

Properties

Methods

Properties

aborted

Readonly aborted: boolean

Whether the request is aborted.

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:18


reason

Optional Readonly reason: any

The abort reason.

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:22

Methods

addEventListener

addEventListener(type, listener): void

Add an event listener to be triggered when this signal becomes aborted.

Parameters

Name Type
type "abort"
listener () => void

Returns

void

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:26


removeEventListener

removeEventListener(type, listener): void

Remove an event listener that was previously added with AbortSignal.addEventListener.

Parameters

Name Type
type "abort"
listener () => void

Returns

void

Defined in

node_modules/formdata-node/node_modules/web-streams-polyfill/types/ponyfill.d.ts:30

Typescript Libraries

Modules

Namespaces

Clone this wiki locally