Skip to content

Latest commit

 

History

History
138 lines (90 loc) · 3.45 KB

README.md

File metadata and controls

138 lines (90 loc) · 3.45 KB
Raw

suncronjob

This is a version of cron that is based around sunrise and sunset rather than a fixed time of day.

Instalation

npm install suncronjob

Note

From version 2.0.0 onwards, this no longer calls an external library for the cron function. Also this version uses a different syntax from version 1.

Example

SunCronJob = require('suncronjob');

options = {
  latitude: 59.436962,      // Tallinn, Estonia
  longitude: 24.753574,
  hours: 1,             // One hour,
  minutes: 10,          // ten minutes
  seconds: 30,          // and 30 seconds
  offset: 'after',      // after
  riseset: 'sunrise',   // sunrise
  once: false           // every day.
};

const task = function() {
  console.log("Hello, World!");

const job = new SunCronJob(options, task);

Usage

Constructor

SunCronJob = require('suncronjob');

const job = new SunCronJob(options, task);

Options

latitude (Default: London, Greenwich)

longitude (Default: London, Greenwich)

These must be set in order for the sunrise and sunset times to be calculated correctly. They are expressed as positive decimals for North and East, negative for South and West.

hours (Default: zero)

minutes (Default: zero)

seconds (Default: zero)

This is the time before or after sunrise or sunset that the job should run.

offset (Default: before)

This must be set to "before" or "after" (or left unset).

riseset (Default: sunrise)

This must be set to "sunrise" or "sunset" (or left unset).

once (Default: false)

If set to true, this job will only run once.

Task

This is the function to run each day at the time before or after sunset as specified.

Function

job.cancel()

This cancels the timer and thus stops the job. There is no way to restart it, other than calling new() again.

Acknowlegements

Many thanks to Kelektiv for his excellent cron package.

However, version 2.0.0 of this package no longer uses the cron package.

Author

Cliff Stanford <[email protected]>

Issues

Please report all issues via the Github issues page.

Licence

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author of this software dedicates any and all copyright interest in the software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org