timeto

1.5.0 • Public • Published

timeTo

A tiny utility to convert time to another unit

Installation

$ npm install timeto

Usage

Supported time units:

  • y - Year (defined as 365.25 days)
  • d - Day
  • h - Hours
  • m - Minutes
  • s - Seconds
  • ms - Milliseconds
timeTo(
  '1d12h', // a string for the input time
  'ms'     // output value for the time period (defaults to ms)
)

It can also take an object of shape { /* time unit */ h: 12 /* amount */ }

timeTo(
  { d: 1, h: 12 }, // an object specifying the duration
  'm'              // output value for the time period (defaults to ms)
)

Alternatively you can pass a number as the input specified as a time period in milliseconds and return it in another duration

timeTo(
  86400000, // a number in milliseconds for the input time
  'm'       // output value for the time period (defaults to ms)
)

Returns a number that is the input time duration in terms of the output time unit specified

Example

const timeTo = require('timeto')
 
const msValue = timeTo('1d12h' /* 1 day 12 hours */, 'ms')
 
console.log(msValue) // 129600000

Additional notes

  • Time units must be lowercase
  • Months are not supported since they fluctuate in duration

Readme

Keywords

none

Package Sidebar

Install

npm i timeto

Weekly Downloads

0

Version

1.5.0

License

ISC

Unpacked Size

5.57 kB

Total Files

4

Last publish

Collaborators

  • lozlow