timeout-percentage
Version:
Similar to setTimeout, but with multiple intervals to report elapsed time.
74 lines (53 loc) • 1.8 kB
Markdown
# timeout-percentage
[](https://www.npmjs.com/package/timeout-percentage)
[![NPM Downloads][downloads-image]][downloads-url]
<!-- [![NPM Downloads][downloads-image-m]][downloads-url] -->
[downloads-image-m]: https://img.shields.io/npm/dm/timeout-percentage.svg
[downloads-image]: https://img.shields.io/npm/dt/timeout-percentage.svg
[downloads-url]: https://npmjs.org/package/timeout-percentage
Similar to `setTimeout`, but periodically reports what percentage of the time has elapsed.
For example, for a timeout value of `1000ms`, you can set `10` intervals, each `100ms`, where you get a callback which reports the elapsed time in percentage. This is useful for creating progress bars.
You can also cancel the timeout before it ends.
**Update**: Now it can be called multiple times in parallel to setup multiple parallel timeouts.
# Install
```bash
npm i -s timeout-percentage
```
# Usage
```javascript
const tp = require("../lib/index.js");
function intervalCallback(percentage) {
console.log(`${percentage}% done.`);
}
function intervalEndCallback() {
console.log(`Interval finished!`);
}
let options = {
intervalCallback: intervalCallback, // Will be called at each interval
intervalEndCallback: intervalEndCallback, // Will be called at the end of the timeout
totalTimeout: 1000, // Total timeout in ms
numberOfIntervals: 10 // Number of intervals
};
tp().start(options);
/*
Output:
10% done.
20% done.
30% done.
40% done.
50% done.
60% done.
70% done.
80% done.
90% done.
100% done.
Interval finished!
*/
```
See [test/test.js](test/test.js) for more examples.
# Cancelling the timer
You can cancel a timer that is still running:
```javascript
let myTimer = tp().start(options);
tp().stop(myTimer);
```