Task Scheduler

Overview

The Task Scheduler is a Node.js package designed to provide a simple and flexible way to schedule tasks to run at specified intervals. It allows users to schedule tasks with custom functions and intervals and provides methods for managing scheduled tasks.

Installation

To install the Task Scheduler package, use npm:

npm install task-scheduler

Usage

To use the Task Scheduler in your Node.js application, import the TaskScheduler class and create an instance. You can then use the provided methods to schedule and cancel tasks as needed.

const TaskScheduler = require('task-scheduler');

const scheduler = new TaskScheduler();

// Schedule a task to run every 5 seconds
const task1 = scheduler.scheduleTask('Task 1', () => {
  console.log('Task 1 executed');
}, 5000);

// Schedule a task to run every 10 seconds
const task2 = scheduler.scheduleTask('Task 2', () => {
  console.log('Task 2 executed');
}, 10000);

// Cancel a scheduled task
scheduler.cancelTask('Task 1');

API

scheduleTask(taskName, taskFunction, interval)

Schedule a new task to run at the specified interval.

• taskName (string): The name of the task.
• taskFunction (function): The function to be executed as the task.
• interval (number): The interval in milliseconds at which the task should be executed.

Returns an object representing the scheduled task.

cancelTask(taskName)

Cancel a scheduled task by its name.

• taskName (string): The name of the task to cancel.

Returns true if the task was successfully canceled, or false if the task with the given name was not found.

License

This project is licensed under the MIT License - see the LICENSE file for details.