Class AbortSignal

Package version

An aborter instance implements AbortSignal interface, can abort HTTP requests.

Call AbortSignal.none to create a new AbortSignal instance that cannot be cancelled. Use AbortSignal.none when you are required to pass a cancellation token but the operation cannot or will not ever be cancelled.

example: // Abort without timeout await doAsyncWork(AbortSignal.none);
export
class: AbortSignal
implements: {AbortSignalLike}

Hierarchy

AbortSignal

Implements

AbortSignalLike

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AbortSignal(): AbortSignal

- Defined in home/vsts/work/1/s/sdk/core/abort-controller/types/src/AbortSignal.d.ts:35
Returns AbortSignal

Properties

aborted

aborted: boolean

Status of whether aborted or not.

readonly
type: {boolean}
memberof: AbortSignal

onabort

onabort: null | function

onabort event listener.

memberof: AbortSignal

Static none

none: AbortSignal

Creates a new AbortSignal instance that will never be aborted.

readonly
static
type: {AbortSignal}
memberof: AbortSignal

Methods

addEventListener

addEventListener(_type: "abort", listener: function): void

- Defined in home/vsts/work/1/s/sdk/core/abort-controller/types/src/AbortSignal.d.ts:67
Added new "abort" event listener, only support "abort" event.

memberof

AbortSignal

Parameters
- _type: "abort"
  
  Only support "abort" event
- listener: function
  - - (this: AbortSignalLike, ev: any): any
    - Parameters
      - this: AbortSignalLike
      - ev: any
      Returns any
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

- Defined in home/vsts/work/1/s/sdk/core/abort-controller/types/src/AbortSignal.d.ts:79
Dispatches a synthetic event to the AbortSignal.

Parameters
- event: Event
Returns boolean

removeEventListener

removeEventListener(_type: "abort", listener: function): void

- Defined in home/vsts/work/1/s/sdk/core/abort-controller/types/src/AbortSignal.d.ts:75
Remove "abort" event listener, only support "abort" event.

memberof

AbortSignal

Parameters
- _type: "abort"
  
  Only support "abort" event
- listener: function
  - - (this: AbortSignalLike, ev: any): any
    - Parameters
      - this: AbortSignalLike
      - ev: any
      Returns any
Returns void

Generated using TypeDoc