schedule-later v1.1.2

Schedule Later

schedule-later provides functions for managing date-time based tasks, such as starting timeouts and intervals at a specific time of day. Under-the-hood, it uses setTimeout and setInterval.

Install

npm install schedule-later

or

yarn add schedule-later

Import

import { startTimeout, startInterval, TimeInMS } from 'schedule-later'

Key Concepts

TimeOfDay

A TimeOfDay object is used to represent a specific time of day. It is an object containing the hour, minute, and seconds.

export interface TimeOfDay {
  hour: number
  minute?: number
  seconds?: number
}

TimeUntil

A TimeUntil object is used to represent a specific time until a certain event. It can represent time until a certain date, milliseconds from now, or a specific time of day.

export type TimeUntil = {
  timeOfDay?: TimeOfDay
  date?: Date
  ms?: number
}

Usage

startTimeout

The startTimeout function starts a timeout that calls a given function after a specific delay. The delay is calculated based on the TimeUntil object passed to it. The function returns a StopFunction (see below).

function startTimeout(timerFunc: Function, start: TimeUntil): StopFunction

startInterval

The startInterval function starts an interval that calls a given function repeatedly with a fixed time delay between each call. Like startTimeout, the initial delay is calculated based on a TimeUntil object. If called with callbackAfterTimeout set to true, it will call intervalFunc after the timeout has finished running (right when starting the interval). The function returns a StopFunction (see below).

function startInterval(
  intervalFunc: Function,
  intervalMS: number,
  start?: TimeUntil
  callbackAfterTimeout: boolean = false
): StopFunction

Stop Functions

Both the startTimeout and startInterval functions return a StopFunction. This function can be called to cancel a timeout or interval.

When called with no arguments, the StopFunction stops the timeout or interval immediately. If called with a TimeUntil argument, it schedules a stop at the specified time.

Here is the type definition of a StopFunction:

type StopFunction = (stopTime?: TimeUntil) => StopCancelFunction | null

Stop Cancel Functions

The StopFunction will return a StopCancelFunction when called with a stopTime. This function can be called to cancel a scheduled stop.

type StopCancelFunction = (stopRunning: boolean = false) => void

In the StopCancelFunction, if the stopRunning parameter is true, it stops the timeout or interval immediately. If stopRunning is false, it cancels the scheduled stop.

Examples

1. Start a timeout that says "Hello, world!" after 10 seconds, then stop it after 5 seconds.

   const sayHello = () => console.log('Hello, world!')
   
   // Start a timeout that says "Hello, world!" after 10 seconds, and stop it after 5 seconds.
   let stopTimeout = Scheduler.startTimeout(sayHello, { ms: 10000 })
   stopTimeout({ ms: 5000 })

2. Using startTimeout with a specific time of day

   const goodMorning = () => console.log('Good morning!')
   let stopTimeout = Scheduler.startTimeout(goodMorning, {
     timeOfDay: { hour: 7, minute: 0 },
   })
   
   // Later, if you want to cancel the morning greeting
   stopTimeout()

   In this example, the goodMorning function will be called at 7:00 AM. If you want to cancel the morning greeting (for example, the user chose to sleep in), you can call the stopTimeout function.  

3. Using startInterval with a specific interval, basically a regular setInterval. Uses the TimeInMS enum to clearly specify the interval.

   const sayHello = () => console.log('Hello, world!')
   let stopInterval = Scheduler.startInterval(sayHello, TimeInMS.SECOND * 5)
   
   // Later, if you want to stop the interval
   stopInterval()

4. Using startInterval with a specific time of day

   const sayHello = () => console.log('Hello, world!')
   let stopInterval = Scheduler.startInterval(sayHello, 1000, {
     timeOfDay: { hour: 7, minute: 0 },
   })
   
   // Later, if you want to stop the interval
   stopInterval()

   In this example, the sayHello function will be called every 1000 milliseconds starting at 7:00 AM. If you want to cancel the morning greeting (for example, the user chose to sleep in), you can call the stopInterval function.