Nachos Preventing Motivation

    This package has been deprecated

    Author message:

    bs-cron is replaced by rescript-cron, please update your dependencies to receive further updates

    bs-cron

    1.1.0 • Public • Published

    bs-cron

    NPM version Build Status

    Bindings for node-cron, a tool that allows you to execute something on a schedule. This is typically done using the cron syntax:

    *    *    *    *    *    *
    ┬    ┬    ┬    ┬    ┬    ┬
    │    │    │    │    │    │
    │    │    │    │    │    └ day of week (0 - 6, or sun - sat), 0 is Sunday
    │    │    │    │    └───── month (0 - 11, or jan - dec)
    │    │    │    └────────── day of month (1 - 31)
    │    │    └─────────────── hour (0 - 23)
    │    └──────────────────── minute (0 - 59)
    └───────────────────────── second (0 - 59, OPTIONAL)
    

    Learn more about the syntax at crontab.guru (NB it does not have the seconds parameter and months start at 1 (this lib has 0-indexed months)).

    Getting started

    yarn add bs-cron
    

    Then add bs-cron as a dependency to bsconfig.json:

    "bs-dependencies": [
    +  "bs-cron"
    ]

    Example

    open BsCron
     
    // Make a job that will fire every second when started
    let job =
      CronJob.make(
        `CronString("* * * * * *"),
        _ => Js.log("Just doing my job"),
        (),
      );
     
    // Firing every second, printing 'Just doing my job'
    start(job);
     
    let time =
      CronTime.make(`JsDate(Js.Date.fromString("2021-04-11T10:20:30Z")), ());
     
    // setTime will stop the current job, and change when it will fire next
    setTime(job, time);
     
    // It will now fire once in april 2021
    start(job);

    The tests have more examples of how to use these bindings.

    Contribute

    • If you find bugs or want to improve this library, feel free to open an issue or PR.
    • If you are upgrading any dependencies, please use yarn so yarn.lock is updated.
    • Try to adhere to Angular commit guidelines.

    Alternatives

    node-schedule is a JS library similar to node-cron (which this library is bindings for).

    Install

    npm i bs-cron

    DownloadsWeekly Downloads

    3

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    62.9 kB

    Total Files

    14

    Last publish

    Collaborators

    • mikaello