Logo for jsDocs.io

abort-controller

  • Version 3.0.0
  • Published
  • 76.3 kB
  • 1 dependency
  • MIT license

Install

npm i abort-controller
yarn add abort-controller
pnpm add abort-controller

Overview

An implementation of WHATWG AbortController interface.

Index

Classes

Classes

class AbortController

class AbortController {}

  • The AbortController.

    See Also

    • https://dom.spec.whatwg.org/#abortcontroller

constructor

constructor();

  • Initialize this controller.

property signal

readonly signal: AbortSignal;

  • Returns the AbortSignal object associated with this object.

method abort

abort: () => void;

  • Abort and signal to any observers that the associated activity is to be aborted.

class AbortSignal

class AbortSignal extends EventTarget<Events, EventAttributes> {}

  • The signal class.

    See Also

    • https://dom.spec.whatwg.org/#abortsignal

constructor

constructor();

  • AbortSignal cannot be constructed directly.

property aborted

readonly aborted: boolean;

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

Package Files (1)

Dependencies (1)

Dev Dependencies (36)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/abort-controller.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/abort-controller)
  • HTML
    <a href="https://www.jsdocs.io/package/abort-controller"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>