Time Turner :clock4:
time-turner-js provides a simple way of rounding time to the nearest minutes (nearest quarter, nearest 30 minutes etc.) in a browser & Node.js.
The library is available as an npm package. To install the package run:
npm install time-turner-js --save
# or with yarn
yarn add time-turner-js
Docs
roundToNearestMinutes(input, nearestMinutes)
Rounds the given time to the nearest specified minutes
Arguments
Name | Type | Description |
---|
input | string or Date | Time to round |
nearestMinutes | number | The closest minute to round to. Must be from 1 to 30 . If 0 is provided it will return the same time or Date |
Returns ( Date | string | undefined )
Date
- If input is a valid date string (ex. 2019-08-30 14:14 UTC+8
) or a Date object.
string
- Returns the rounded time in the same format that it was given unless given input is a date string. For example if input is 10:12 AM
, it will return the rounded time as 10:15 AM
which has the same format of hh:mm A
as the input.
undefined
- If arguments provided are invalid or if an error occured while rounding the time. The library will not throw any error.
Usage
import { roundToNearestMinutes } from 'time-turner-js';
roundToNearestMinutes('10:12am', 15);
roundToNearestMinutes('04:06 PM', 10);
roundToNearestMinutes('04:06 PM', 10);
roundToNearestMinutes('01:02:34.75', 10);
roundToNearestMinutes('8:22:25 PM', 10);
roundToNearestMinutes('2:33p.m.', 10)
roundToNearestMinutes('8:22:25 PM', 10);
roundToNearestMinutes('11:51P.M.', 10);
roundToNearestMinutes('11:59P.M.', 10);
roundToNearestMinutes('23:59', 10);
roundToNearestMinutes('08:70', 15);
roundToNearestMinutes('2019-08-30', 5);
roundToNearestMinutes('2019-08-30 14:14 UTC+8', 15));
roundToNearestMinutes('2009-06-15T13:45:30', 10));
roundToNearestMinutes('2019-08-30 14:14 UTC+8', 0);
License
MIT © Ana Liza Pandac