TooTallNate / ms

Tiny milisecond conversion utility

Home Page:https://npmjs.com/ms

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ms

Build Status

Easily convert various time format string to milliseconds, or format milliseconds into a human-readable time format string.

Usage

For Node.js or a web browser:

import ms from 'ms';

For Deno:

import ms from 'https://denopkg.com/vercel/ms';

Examples

ms('2 days')     // 172800000
ms('1d')         // 86400000
ms('10h')        // 36000000
ms('2.5 hrs')    // 9000000
ms('2h')         // 7200000
ms('1m')         // 60000
ms('5s')         // 5000
ms('1y')         // 31557600000
ms('100')        // 100
ms('-3 days')    // -259200000
ms('-1h')        // -3600000
ms('-200')       // -200

Convert from Milliseconds

ms(60000)             // "1m"
ms(2 * 60000)         // "2m"
ms(-3 * 60000)        // "-3m"
ms(ms('10 hours'))    // "10h"

Time Format Written-Out

ms(60000, { long: true })             // "1 minute"
ms(2 * 60000, { long: true })         // "2 minutes"
ms(-3 * 60000, { long: true })        // "-3 minutes"
ms(ms('10 hours'), { long: true })    // "10 hours"

Features

  • Works in Node.js, Deno and the browser
  • If a number is supplied to ms, a string with a unit is returned
  • If a string that contains the number is supplied, it returns it as a number (e.g.: it returns 100 for '100')
  • If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned

Related Packages

  • ms.macro - Run ms as a macro at build-time.

Caught a Bug?

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Link the package to the global module directory: npm link
  3. Within the module you want to test your local development instance of ms, just link it to the dependencies: npm link ms. Instead of the default one from npm, Node.js will now use your clone of ms!

As always, you can run the tests using: npm test

About

Tiny milisecond conversion utility

https://npmjs.com/ms

License:MIT License


Languages

Language:JavaScript 65.1%Language:TypeScript 34.9%