retimeable-signal

An AbortSignal that fires on a resetable timeout

About

This module exports a retimeableSignal function that returns an AbortSignal that fires an "abort" event after a specified number of ms.

It has been augmented with two additional methods reset and clear which change the timeout time and prevent it from firing entirely.

Example

import { retimeableSignal } from 'retimeable-signal'

const signal = retimeableSignal(100)

//... time passes, reset timeout to now + 100ms
signal.reset(100)

// stop the signal from aborting at all
signal.clear()
Copy

Prior art

This is module is inspired by the retimer module except that uses setTimeout which can cause a Node.js process to stay open, this uses AbortSignal.timeout which does not.

Install

$ npm i retimeable-signal
Copy

Browser <script> tag

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

<script src="https://unpkg.com/retimeable-signal/dist/index.min.js"></script>
Copy

API Docs

• https://achingbrain.github.io/retimeable-signal

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.