moongarm-scheduling v1.0.0

Moongarm Task Scheduling - NodeJS Library

NodeJS library for crontab task scheduling. Inspired by Laravel task scheduling.

Features

• API like Laravel task scheduling
• Can use REST API url
• Custom timezone

Installation

npm install moongarm-scheduling

How to use

Defining Schedules

You may define all of your scheduled tasks. To get started, let's look at an example of scheduling a task. In this example, we will schedule a function to be called every minutes.

const scheduled = require('moongarm-scheduling');

scheduled
  .call(() => {
    console.log('Tester call schedule task')
  })
  .everyMinutes()
  .run((response) => {
    console.log(response);
  });

Defining Schedules with REST API

You can also define all of your scheduled tasks with calling your REST API. To get started, let's look at an example of scheduling a task with calling REST API. In this example, we will schedule REST API with method GET, PUT and POST to be called every minutes.

With GET method

const scheduled = require('moongarm-scheduling');

scheduled
  .get('http://127.0.0.1/call/task')
  .everyMinutes()
  .run((response) => {
    console.log(response);
  });

With POST method

const scheduled = require('moongarm-scheduling');

scheduled
  .post('http://127.0.0.1/call/task')
  .everyMinutes()
  .run((response) => {
    console.log(response);
  });

With PUT method

const scheduled = require('moongarm-scheduling');

scheduled
  .put('http://127.0.0.1/call/task')
  .everyMinutes()
  .run((response) => {
    console.log(response);
  });

#Schedule Frequency Options Of course, there are a variety of schedules you may assign to your task:

These methods may be combined with additional constraints to create even more finely tuned schedules that only run on certain days of the week. For example, to schedule a command to run weekly on Monday at 09:00AM:

const scheduled = require('moongarm-scheduling');

scheduled
  .put('http://127.0.0.1/call/task')
  .weekly()
  .mondays()
  .at('09:00')
  .run((response) => {
    console.log(response);
  });

Timezones

Using the timezone, you may specify that a scheduled task's time should be interpreted within a given timezone:

const scheduled = require('moongarm-scheduling');

scheduled
  .put('http://127.0.0.1/call/task')
  .weekly()
  .timezone('Asia/Jakarta')
  .run((response) => {
    console.log(response);
  });