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

@egomobile/jobs

v0.8.0

Published

Easy to use job scheduler helpers.

Downloads

46

Readme

npm last build PRs Welcome

@egomobile/jobs

Easy to use job scheduler helpers, which are compatible with Node.js 12 or later.

Install

Execute the following command from your project folder, where your package.json file is stored:

npm install --save @egomobile/jobs

Usage

Quick example

First make a sub directory, lets say /jobs, where your job script files will be stored.

The create a file, called myJob.ts, and start with the following skeleton:

import { IJobConfig, IJobExecutionContext, JobAction } from "@egomobile/jobs";

// the action that is executed on every tick
const onTick: JobAction = async ({ file, time }: IJobExecutionContext) => {
  console.log("Job in file", file, "is executed on", time);
};

const config: IJobConfig = {
  onTick,

  // run the job directly, after it has been initialized
  runOnInit: true,
  // s. https://github.com/node-schedule/node-schedule#cron-style-scheduling
  time: "42 * * * * *",
};

export default config;

In the entry point of your application, lets say /index.ts, use one of the functions loadAndStartJobs() or loadAndStartJobsSync() to load, init and start all jobs in the directory:

import path from "path";
import { loadAndStartJobs } from "@egomobile/jobs";

async function main() {
  const jobs = await loadAndStartJobs({
    // all script files are stored in
    // /jobs sub folder
    dir: path.join(__dirname, "jobs"),

    // only use TypeScript files
    filter: ".ts",

    // custom timezone
    timezone: "Europe/Berlin",
  });

  console.log(
    String(jobs.length),
    "jobs have been loaded, initialized and started",
  );
}

main().catch(console.error);

Credits

The module makes use of:

Documentation

The API documentation can be found here.