purescript-contrib/purescript-js-abort-controller

Web/Node bindings to `AbortController`/`AbortSignal`

JS Abort Controller

Low level bindings to the AbortController and AbortSignal APIs:

• AbortController
  • Node docs: https://nodejs.org/docs/latest/api/globals.html#class-abortcontroller
  • Web docs: https://dom.spec.whatwg.org/#interface-abortcontroller
• AbortSignal
  • Node docs: https://nodejs.org/docs/latest/api/globals.html#class-abortsignal
  • Web docs: https://dom.spec.whatwg.org/#interface-AbortSignal

Installation

Install js-abort-controller with Spago:

spago install js-abort-controller

Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the docs directory.

Documentation

js-abort-controller documentation is stored in a few places:

1. Module documentation is published on Pursuit.
2. Written documentation is kept in the docs directory.

If you get stuck, there are several ways to get help:

• Open an issue if you have encountered a bug or problem.
• Ask general questions on the PureScript Discourse forum or the PureScript Discord chat.

Contributing

You can contribute to js-abort-controller in several ways:

1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.