firebase-cron

firebase-cron

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

• firebase-queue: A fault-tolerant, multi-worker, multi-stage job pipeline built on Firebase | homepage
• firebase: Firebase JavaScript library for web and Node.js | homepage

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

• github/doowb
• twitter/doowb

License

Copyright © 2018, Brian Woodward. MIT

---

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