Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wojtekmaj/opening-hours-utils
A collection of opening hours-related utilities.
https://github.com/wojtekmaj/opening-hours-utils
Last synced: 17 days ago
JSON representation
A collection of opening hours-related utilities.
- Host: GitHub
- URL: https://github.com/wojtekmaj/opening-hours-utils
- Owner: wojtekmaj
- License: mit
- Created: 2022-07-19T14:10:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-27T07:16:54.000Z (about 2 months ago)
- Last Synced: 2024-10-14T11:19:25.602Z (30 days ago)
- Language: TypeScript
- Size: 1.43 MB
- Stars: 13
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@wojtekmaj/opening-hours-utils)  [](https://github.com/wojtekmaj/opening-hours-utils/actions)
# 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!
```ts
const openingHours = getOpeningHours('Mo-Fr 08:00-18:00;Sa 08:00-12:00');
```
## User guide
### Table of contents
- [`encodeOpeningHours()`](#encodeOpeningHours)
- [`getDailyOpeningHours()`](#getDailyOpeningHours)
- [`getIsOpenAt()`](#getIsOpenAt)
- [`getIsOpenNow()`](#getIsOpenNow)
- [`getNextClosedAt()`](#getNextClosedAt)
- [`getNextClosedNow()`](#getNextClosedNow)
- [`getNextOpenAt()`](#getNextOpenAt)
- [`getNextOpenNow()`](#getNextOpenNow)
- [`getOpeningHours()`](#getOpeningHours)
### `encodeOpeningHours()`
Returns opening hours string given an array of objects with `from`, `to`, and `hours` properties.
#### Sample usage
```ts
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.
#### Sample usage
```ts
import { getDailyOpeningHours } from '@wojtekmaj/opening-hours-utils';
getDailyOpeningHours('Mo-Fr 08:00-17:30');
/**
* [
* { 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' }] },
* ]
*/
```
### `getIsOpenAt()`
Checks if place is open at a given date.
#### Sample usage
```ts
import { getIsOpenAt } from '@wojtekmaj/opening-hours-utils';
getIsOpenAt('Mo-Fr 08:00-17:30', mondayNoon); // true
```
### `getIsOpenNow()`
Checks if place is open.
#### Sample usage
```ts
import { getIsOpenNow } from '@wojtekmaj/opening-hours-utils';
getIsOpenNow('Mo-Fr 08:00-17:30'); // true
```
### `getNextClosedAt()`
Gets the next closing time for a given date. Returns null if for a given date place is closed.
#### Sample usage
```ts
import { getNextClosedAt } from '@wojtekmaj/opening-hours-utils';
getNextClosedAt('Mo-Fr 08:00-17:30', mondayNoon); // 'Mo 17:30'
```
### `getNextClosedNow()`
Gets the next closing time. Returns null if place is currently closed.
#### Sample usage
```ts
import { getNextClosedNow } from '@wojtekmaj/opening-hours-utils';
getNextClosedNow('Mo-Fr 08:00-17:30'); // 'Mo 17:30'
```
### `getNextOpenAt()`
Gets the next opening time for a given date. Returns null if for a given date place is open.
#### Sample usage
```ts
import { getNextOpenAt } from '@wojtekmaj/opening-hours-utils';
getNextOpenAt('Mo-Fr 08:00-17:30', saturdayNoon); // 'Mo 08:00'
```
### `getNextOpenNow()`
Gets the next opening time. Returns null if place is currently open.
#### Sample usage
```ts
import { getNextOpenNow } from '@wojtekmaj/opening-hours-utils';
getNextOpenNow('Mo-Fr 08:00-17:30'); // 'Mo 08:00'
```
### `getOpeningHours()`
Parses opening hours string and returns an array of objects with `from`, `to`, and `hours` properties.
#### Sample usage
```ts
import { getOpeningHours } from '@wojtekmaj/opening-hours-utils';
getOpeningHours('Mo-Fr 08:00-17:30');
/**
* [
* {
* from: 'Mo',
* to: 'Fr',
* hours: [{ from: '08:00', to: '17:30' }],
* },
* ]
*/
```
## License
The MIT License.
## Author
