abort-error

abort-error

An error to be used by AbortSignal handlers

About

A simple error class and options interface that seems to get copied from project to project.

Example - Using AbortError

import { AbortError } from 'abort-error'

// a promise that will be settled later
const deferred = Promise.withResolvers()

const signal = AbortSignal.timeout(1000)
signal.addEventListener('abort', () => {
  deferred.reject(new AbortError())
})

Example - Using AbortOptions

import type { AbortOptions } from 'abort-error'

async function myFunction (options?: AbortOptions) {
  return fetch('https://example.com', {
    signal: options?.signal
  })
}

Install

$ npm i abort-error

Browser <script> tag

Loading this module through a script tag will make its exports available as AbortError in the global namespace.

<script src="https://unpkg.com/abort-error/dist/index.min.js"></script>

API Docs

• https://achingbrain.github.io/abort-error

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Changelog

1.0.0 (2024-10-24)

Features

• initial commit (b170f3e)

Trivial Changes

• fix tests (1f2d2fa)

Documentation

• update readme (84a8a57)