Awesome Open Source
Awesome Open Source

⏰ periodic-promise ⏰

Asynchronous periodic polling with promise.


**Photo by [Icons8 team](https://unsplash.com/icons8) on [Unsplash](https://unsplash.com/)**

NPM Version Downloads CircleCI Status Known Vulnerabilities Maintainability Netlify Status


⏰ What is "periodic promise"?

It's a lightweight library that answers the following need:

  • resolving a Promise at specified intervals (in milliseconds)
  • calling a callback after every cycle exposing the response of the Promise
  • externally breaking the cycle
  • defining a specified number of iterations

Promises are a JavaScript feature that allow you to defer further actions until after a previous action has completed, or respond to its failure.

⭐️ How to get it

NPM:

npm install periodic-promise

YARN:

yarn add periodic-promise

CDN: https://unpkg.com/periodic-promise

⭐️ Usage in a nutshell

This code will call every 2 seconds the "foo.api()" until the response will return "bar".

(async () => {
  const callback = r => r === 'bar';
  await periodicPromise(2000, () => foo.api(), callback)
})()

This example will do the same, but it will perform only 20 iterations.

(async () => {
  const callback = r => r === 'bar';
  await periodicPromise(2000, () => foo.api(), callback, 20)
})()

Live example:

See the live example: https://periodic-promise.netlify.com/

📖 API

Syntax

periodicPromise(delay, action, callback, limit);

Parameter values

Parameter Description Default value
delay Required. The intervals in milliseconds on how often to execute the code. ( > 0) N/A
action Required. The function that will be executed. N/A
callback Required. The function that will be call after every execution with the response of "action" as first param. If the returned value is truthy, the execution will continue. If the returned value is falsy, the execution will be stopped. N/A
limit Optional. After how many times the execution will be stopped. undefined (no limit)

📝 Documentation

🚨 Tests

Run your unit tests once:

npm run test

or in watch mode:

npm run test:watch

👷 Build

Build the library:

npm run build

🚀 Dev mode

In dev mode, you can build in real-time your changes:

npm run dev

❗️ Issues

I'm sure you'll find bugs and when you do it would be great if you'd could report them here.

💪 Contribution

The project is still in its early stages and in progress. I think there's no need for guidelines yet, so feel free to contribute or give feedback as you prefer.

©️ License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,555,917
Typescript (254,029
Async (3,155
Promise (1,431
Interval (216
Polling (142
Timeout (139
Related Projects