business-timer v0.1.0

Business Timer

Lightweight utilities for calculating time during business hours.

Installation

$ npm i business-timer

Usage

Create an instance of BusinessTimer and put it to work:

import BusinessTimer from 'business-timer';

const bt = new BusinessTimer(opts);
const dt = bt.diff('2020-01-01T00:00:00Z', '2020-01-10T00:00:00Z');
console.log(dt); // 291600000

Options

A new BusinessTimer can be configured with both weekly and holiday schedules:

const opts = {
  hours: [ // Sun, Mon, ...
    null,
    ["08:00", "17:00"],
    ["08:00", "17:00"],
    ["08:00", "17:00"],
    ["08:00", "17:00"],
    ["08:00", "17:00"],
    null,
  ],
  holidays: [
    '2021-04-01'
  ],
  timeZone: 'America/Los_Angeles',
};

const bt = new BusinessTimer(opts);

diff(begin: DateLike, end: DateLike): number

Computes the working time elapsed (in ms) between begin and end.

isOpen(datetime: DateLike): boolean

Check whether datetime falls within business hours

isWorkday(date: DateLike): boolean

Check whether date is a workday for the business

License

ISC