# interval-promise > setInterval with setTimeout semantics for promises and async/await Latest version **1.4.0** (published 2020-01-15) · MIT license · 0 weekly downloads ## Install ```sh npm install interval-promise pnpm add interval-promise yarn add interval-promise bun add interval-promise ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.4.0 | | Published | 2020-01-15 | | First published | 2017-11-25 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 19.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 105 | | Author | Andy Fleming | | Maintainers | andyfleming | | Keywords | interval, promise, setTimeout, setInterval, timer, repeat, repeatEvery, async, await | ## Links - npm: https://www.npmjs.com/package/interval-promise - Repository: https://github.com/andyfleming/interval-promise - Homepage: https://github.com/andyfleming/interval-promise#readme - Issues: https://github.com/andyfleming/interval-promise/issues - npm.io page: https://npm.io/package/interval-promise ## Alternatives - [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads - [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads - [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads - [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads - [fa](https://npm.io/package/fa.md) — 185 weekly downloads ## Recent versions - 1.4.0 (latest) — 2020-01-15 - 1.3.0 — 2018-10-09 - 1.2.0 — 2018-06-06 - 1.1.1 — 2018-02-10 - 1.1.0 — 2017-11-26 - 1.0.0 — 2017-11-25 - 0.1.0 — 2017-11-25 ## README # Interval Promise [![NPM Version](https://img.shields.io/npm/v/interval-promise.svg)](https://npmjs.org/package/interval-promise) [![Build Status](https://travis-ci.org/andyfleming/interval-promise.svg?branch=master)](https://travis-ci.org/andyfleming/interval-promise) [![Coverage Status](https://coveralls.io/repos/github/andyfleming/interval-promise/badge.svg?branch=master)](https://coveralls.io/github/andyfleming/interval-promise?branch=master) ## Overview This library provides a simple mechanism for running a promise with a given amount of time between executions. #### Standard Javascript » setInterval() ![traditional interval](https://user-images.githubusercontent.com/721038/33246371-9d0a6e56-d2c8-11e7-9787-cd67354c9f38.png) #### interval-promise » interval() ![interval promise](https://user-images.githubusercontent.com/721038/33246370-9cf05a20-d2c8-11e7-816c-744ee6b5a094.png) ## Installation ```bash npm install interval-promise ``` ## Usage **Simple example using async-await** ```javascript const interval = require('interval-promise') // Run a function 10 times with 1 second between each iteration interval(async () => { await someOtherPromiseReturningFunction() await another() }, 1000, {iterations: 10}) ``` ## API ```javascript interval(func, intervalLength, options = {}) // returns Promise ``` ### Arguments
Argument Attritubes Description
func function Required
Function to execute for each interval. MUST return a promise.

Two arguments are passed to this function.
  • iterationNumber number — The iteration number (starting at 1)
  • stop function — used to "stop" (skipping all remaining iterations)
intervalLength number | function Required
Length in ms to wait between iterations. Should be (or return) a non-negative integer.

If a function is used, one parameter iterationNumber (starting at 1) is passed.
options object Optional settings (detailed below).
options.iterations number Default: Infinity
The number of times to execute the function. Must be Infinity or an integer greater than 0.
options.stopOnError boolean Default: true
If true, no subsequent calls will be made. The promise returned by interval() will be rejected and pass through the error thrown.
## Project Values * **Approachability** — Basic usage should be concise and readable. * **Debuggability** — Error feedback should be helpful and error handling options should be flexible. * **Stability** — Functionality should be well-tested and reliable. ## Acknowledgements This library was inspired by [reissue](https://github.com/DonutEspresso/reissue). ## FAQ ### How can I stop the interval from _outside_ the interval function? There isn't currently direct feature to stop the iterations externally. You can, however, achieve this by checking a variable in the parent scope (of where the function is defined). Check out the code below. ```js const interval = require('interval-promise') let stoppedExternally = false const stopExternally = () => { stoppedExternally = true } interval(async (iteration, stop) => { if (stoppedExternally) { stop() } // ... normal functionality ... }, 1000) // Some other work... someOtherWork().then(() => { // Now that our "other work" is done, we can stop our interval above with: stopExternally() }) ``` --- _Source: https://npm.io/package/interval-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._