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

firebase-cron

v1.0.1

Published

Store and run cron jobs with firebase.

Downloads

24

Readme

firebase-cron NPM version

Store and run cron jobs with firebase.

Install

Install with npm:

$ npm install --save firebase-cron

Usage

var Cron = require('firebase-cron');

API

Cron

Main Cron class for creating a new instance to manage cron jobs.

Params

  • ref {Object}: Instance of a firebase reference pointing to the root of a firebase.
  • queue {Object}: Instance of a firebase refernece pointing to a firebase-queue.
  • options {Object}: Options specifying where the cron jobs are stored.
  • options.endpoint {String}: Specific endpoint relative to the ref where the cron jobs are stored (defaults to jobs).
  • options.interval {Number}: Optional interval in milliseconds to use when calling .run (defaults to 1000).

Example

const Firebase = require('firebase');
const ref = new Firebase('https://{your-firebase}.firebaseio.com');
const queueRef = new Firebase('https://{your-firebase}.firebaseio.com/queue');
const options = {endpoint: 'jobs'};

const cron = new Cron(ref, queueRef, options);

.addJob

Add a new cron job.

Params

  • name {String}: Name of the cron job.
  • pattern {String}: Cron job pattern. See cron job patterns for specifics.
  • data {Object}: Data to be pushed onto the firebase-queue when job is run.
  • returns {Promise}: Returns a promise that is resolved when the job has been updated.

.updateJob

Update a cron job.

Params

  • name {String}: Name of the cron job.
  • pattern {String}: Cron job pattern. See cron job patterns for specifics.
  • data {Object}: Data to be pushed onto the firebase-queue when job is run.
  • returns {Promise}: Returns a promise that is resolved when the job has been added.

.deleteJob

Remove a cron job.

Params

  • name {String}: Name of the cron job.
  • returns {Promise}: Returns a promise that is resolved when the job has been removed.

.getJob

Get a cron job.

Params

  • name {String}: Name of the cron job.
  • returns {Promise}: Returns a promise that is resolved with the job.

.getJobs

Get all of the cron jobs.

  • returns {Promise}: Returns a promise that is resolved with all of the jobs.

.waitingJobs

Get all of the scheduled/waiting jobs.

  • returns {Promise}: Returns a promise that is resolved with the waiting jobs.

.run

Start running the cron manager.

Params

  • cb {Function}: Callback function that is called each time manager checks for jobs to run.
  • error {Function}: Callback function that is called if an error occurrs.

Related projects

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Brian Woodward

License

Copyright © 2018, Brian Woodward. MIT


This file was generated by verb-generate-readme, v0.6.0, on May 17, 2018.