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

@simpleview/async-cron

v0.1.0

Published

Async cron job runner using cron syntax

Downloads

99

Readme

async-cron

Simple cron job runner for Node that handles async functions and uses a Mutex that keeps the same job from running more than once simultaneously.

Installation

npm install @simpleview/async-cron

Example

const { Job } = require("@simpleview/async-cron");

const job = new Job({
	schedule : "*/5 * * * * *"
}, async function() {
	const results = await doSomething();
	return someResult;
});

// Required: Handle errors, or they will be black-holed resulting in not knowing that your crons are failing
job.on("error", function(e) {
	console.log("Cron Error", e);
});

// Not required: if you care about the returned result from a cronJob, you can do something with it here
job.on("result", function(result) {
	
});

// Starts the job running the background
job.start();

Error Handling

If your job errors, the error will be blackholed unless you subscribe to the error handler.

job.on("error", function(e) {
	// do something with the error
});

If you want to differentiate errors from the job running from code errors, you can check the error code.

const { Job, E_RUNNING } = require("@simpleview/async-cron");

const job = new Job(...args...);

job.on("error", function(e) {
	if (e.code === E_RUNNING) {
		console.log("Still running!");
	} else {
		console.log("An actual code problem!");
	}
});

Package API

Job

Job represents a single cron job.

  • args
    • schedule - string - The schedule in cron-parser syntax.
  • fn - function or async function - The function that will execute your job. It should either run fully synchronously, or be an async method/promise-based method. Do not utilize callbacks here, or else the async locking mechanism will not function properly. When this function returns, the job must be complete.

Job.start()

Starts the job running in the background.

Job.stop()

Stops the job. This will not halt functions that are currently executing at this very moment, but it will present new runs from queuing up.

Job.run()

Manually executes the job. If the job errors, then this will throw, this includes throwing if the job is currently executing.

const result = await job.run();

Job.isRunning()

Check if the job is currently running.

const isRunning = job.isRunning();

E_RUNNING

Symbol reference for error.code when an Error is thrown due to an a job already running. See error handling.