Opening-Hours-Utils #

A collection of opening hours-related utilities.

tl;dr #

• Install by executing npm install @wojtekmaj/opening-hours-utils or yarn add @wojtekmaj/opening-hours-utils.
• Import by adding import * as openingHoursUtils from '@wojtekmaj/opening-hours-utils'.
• Do stuff with it!

  const openingHours = getOpeningHours('Mo-Fr 08:00-18:00;Sa 08:00-12:00');
  

User guide #

Table of contents #

• encodeOpeningHours()
• getDailyOpeningHours()
• getIsOpenAt()
• getIsOpenNow()
• getNextClosedAt()
• getNextClosedNow()
• getNextOpenAt()
• getNextOpenNow()
• getOpeningHours()

encodeOpeningHours() #

Returns opening hours string given an array of objects with from, to, and hours properties.

Sample usage #

import { encodeOpeningHours } from '@wojtekmaj/opening-hours-utils';

encodeOpeningHours([
  {
    from: 'Mo',
    to: 'Fr',
    hours: [{ from: '08:00', to: '17:30' }],
  },
]); // 'Mo-Fr 08:00-17:30'

getDailyOpeningHours() #

Parses opening hours string and returns an array of objects with day and hours properties.

Note: This function only returns recurring day groups (e.g., Mo-Fr). Absolute dates (e.g., Jan 26) are not included in the result. Use getOpeningHours() to access absolute date entries.

Sample usage #

import { getDailyOpeningHours } from '@wojtekmaj/opening-hours-utils';

getDailyOpeningHours('Mo-Fr 08:00-17:30; Jan 26 10:00-14:00');
/**
 * [
 *   { day: 'Mo', hours: [{ from: '08:00', to: '17:30' }] },
 *   { day: 'Tu', hours: [{ from: '08:00', to: '17:30' }] },
 *   { day: 'We', hours: [{ from: '08:00', to: '17:30' }] },
 *   { day: 'Th', hours: [{ from: '08:00', to: '17:30' }] },
 *   { day: 'Fr', hours: [{ from: '08:00', to: '17:30' }] },
 * ]
 * // Note: the absolute date entry `Jan 26 10:00-14:00` is ignored here.
 */

getIsOpenAt() #

Checks if place is open at a given date.

Sample usage #

import { getIsOpenAt } from '@wojtekmaj/opening-hours-utils';

getIsOpenAt('Mo-Fr 08:00-17:30', mondayNoon); // true
getIsOpenAt('Jan 26 10:00-14:00', new Date('2025-01-26T11:00:00')); // true
getIsOpenAt('Feb 01-Feb 14 10:00-14:00', new Date('2025-02-01T09:00:00')); // false

getIsOpenNow() #

Checks if place is open.

Sample usage #

import { getIsOpenNow } from '@wojtekmaj/opening-hours-utils';

getIsOpenNow('Mo-Fr 08:00-17:30'); // true
getIsOpenNow('Jan 26 10:00-14:00'); // depends on current date and time

getNextClosedAt() #

Gets the next closing time for a given date. Returns null if for a given date place is closed.

Sample usage #

import { getNextClosedAt } from '@wojtekmaj/opening-hours-utils';

getNextClosedAt('Mo-Fr 08:00-17:30', mondayNoon); // 'Mo 17:30'
getNextClosedAt('Jan 26 10:00-14:00', new Date('2025-01-26T11:00:00')); // 'Jan 26 14:00'

getNextClosedNow() #

Gets the next closing time. Returns null if place is currently closed.

Sample usage #

import { getNextClosedNow } from '@wojtekmaj/opening-hours-utils';

getNextClosedNow('Mo-Fr 08:00-17:30'); // 'Mo 17:30'
getNextClosedNow('Jan 26 10:00-14:00'); // depends on current date and time

getNextOpenAt() #

Gets the next opening time for a given date. Returns null if for a given date place is open.

Sample usage #

import { getNextOpenAt } from '@wojtekmaj/opening-hours-utils';

getNextOpenAt('Mo-Fr 08:00-17:30', saturdayNoon); // 'Mo 08:00'
getNextOpenAt('Feb 01-Feb 14 10:00-14:00', new Date('2025-01-31T12:00:00')); // 'Feb 01 10:00'

getNextOpenNow() #

Gets the next opening time. Returns null if place is currently open.

Sample usage #

import { getNextOpenNow } from '@wojtekmaj/opening-hours-utils';

getNextOpenNow('Mo-Fr 08:00-17:30'); // 'Mo 08:00'
getNextOpenNow('Feb 01-Feb 14 10:00-14:00'); // depends on current date and time

getOpeningHours() #

Parses opening hours string and returns an array of objects with from, to, and hours properties.

Sample usage #

import { getOpeningHours } from '@wojtekmaj/opening-hours-utils';

getOpeningHours('Mo-Fr 08:00-17:30; Jan 26 10:00-14:00; Feb 01-Feb 14 10:00-14:00');
/**
 * [
 *   {
 *     from: 'Mo',
 *     to: 'Fr',
 *     hours: [{ from: '08:00', to: '17:30' }],
 *   },
 *   {
 *     from: 'Jan 26',
 *     to: 'Jan 26',
 *     hours: [{ from: '10:00', to: '14:00' }],
 *   },
 *   {
 *     from: 'Feb 01',
 *     to: 'Feb 14',
 *     hours: [{ from: '10:00', to: '14:00' }],
 *   },
 * ]
 */

License #

The MIT License.

Author #

Wojciech Maj