Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sindresorhus/to-milliseconds

sindresorhus277.9kMIT2.0.0TypeScript support: included

Convert an object of time properties to milliseconds: {seconds: 2} → 2000

parse, object, properties, to, into, time, ms, milliseconds, microseconds, nanoseconds, duration, period, range, interval

readme

to-milliseconds

Convert an object of time properties to milliseconds: {seconds: 2} → 2000

Install

$ npm install @sindresorhus/to-milliseconds

Usage

import toMilliseconds from '@sindresorhus/to-milliseconds';

toMilliseconds({
    days: 15,
    hours: 11,
    minutes: 23,
    seconds: 20,
    milliseconds: 1
});
//=> 1337000001

setTimeout(() => {
    // …
}, toMilliseconds({minutes: 2}));

API

toMilliseconds(timeDescriptor)

timeDescriptor

Type: object

Specify an object with any of the following properties:

  • days
  • hours
  • minutes
  • seconds
  • milliseconds
  • microseconds
  • nanoseconds
  • parse-ms - The inverse of this module
  • pretty-ms - Convert milliseconds to a human readable string