npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

repeaters

v1.0.0

Published

A utility to create tracked, recurring, interruptible timed routines

Downloads

3

Readme

Repeaters

A utility to create tracked, recurring, timed routines which repeat forever (or until aborted).

Install

npm install repeaters

Example Usage

const {RepeaterCollection} = require('repeaters');

const repeaters = new RepeaterCollection();

const repeatingTask = repeaters.add(async ({signal, delta, abort, count}) => {
    console.log(`Task interation #${count}`);
    console.log(`Milliseconds since last run: ${delta}`);

    await someLengthyAsyncFunc();

    if (signal.aborted) return; // if aborted, return early

    await anotherLengthyAsyncFunc();

}, {
    delay: 1000, // start running tasks after 1 second
    interval: 30*1000, // run task every 30 seconds
});

repeatingTask.on('run', (params) => console.log('run', params));
repeatingTask.on('abort', () => console.log('aborting'));
repeatingTask.on('aborted', () => console.log('aborted'));
repeatingTask.on('error', (err) => console.log('error', err));

setTimeout(() => {
    // abort after 5 minutes
    repeatingTask.abort();
}, 5*60*1000);

API

new RepeaterCollection();

Creates an empty collection of Repeaters.

RepeaterCollection#add(callback, options);

Create & add a new tracked Repeater to the collection.

  • callback: A function to be called at the specified interval. The callback will be called until the Repeater is abort()ed.
  • options:
    • interval: Milliseconds between each run of the task (defaults to 0 - runs immediately after previous invocation is complete).
    • delay: Milliseconds before the first run of the task (defaults to 0).
    • context: The this context to bind to the callback.

Returns: Repeater

RepeaterCollection#abort();

Calls abort() on every Repeater in the collection, attempting to stop any running tasks.

Returns a Promise which resolves after all running tasks have ended and are no longer scheduled to run.

Repeater

Repeater#abort();

Stops the recurring task and attempts to signal to any running task that it should return early.

Returns a Promise which resolves after the current running task has ended or when no more tasks are scheduled to run.

Repeater#on(eventName, listener)

Repeater#once(eventName, listener)

Repeater#removeListener(eventName, listener)

(See https://nodejs.org/api/events.html)