Socket
Socket
Sign inDemoInstall

task-repeater

Package Overview
Dependencies
0
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    task-repeater

A micro JavaScript library for running repetitive time-based tasks


Version published
Maintainers
1
Created

Readme

Source

Task repeater

Version Documentation Maintenance License: MIT License: MIT

A tiny (657B Gzipped) micro library to manage repeated tasks with ease.

Install

yarn install

Usage

import TaskRepeater from 'task-repeater';

const job1 = TaskRepeater()
                .do(() => { /*...*/ })
                .every(1000)
                .start();

const job2 = TaskRepeater()
                .do((itteration) => console.log(`itteration No.${itteration} ...`))
                .do(() => { /*...*/ })
                .finally((itterationsDone) => console.log(`tasks done. ${itterationsDone} itterations were completed.`))
                .for(5) // times
                .every(2_000) // interval in miliseconds 
                .delay(1_000) // initial delay in miliseconds
                .start();

job1.stop(); // stops the repetitive calls
job1.reset(); // resets the counter as if it isn't invoked

Author

👤 Omid Astaraki omid.ocean@gmail.com

Credits

this package is based on Repeatr library developed by @theshem.

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Omid Astaraki omid.ocean@gmail.com.
This project is MIT licensed.

Keywords

FAQs

Last updated on 29 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc