Time Turner 🕓
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
// CommonJS// var { roundToNearestMinutes } = require('time-turner-js'); // ES2015; ; // => '10:15am'; // => '04:10 PM'; // => '04:10 PM'; // => '01:00:00.00'; // => '8:20:00 PM' // => '2:30p.m.' ; // => '8:20:00 PM' ; // => '11:50P.M'; // => '12:00A.M'; // => '00:00' // will return undefined for the following calls; // => undefined; // => undefined ); // => new Date('2019-08-30T06:15:00.000Z')); // => new Date('2009-06-15T05:50:00.000Z'); // => new Date('2019-08-30T06:14:00.000Z')
License
MIT © Ana Liza Pandac