| 1 | # ms
|
|---|
| 2 |
|
|---|
| 3 | 
|
|---|
| 4 |
|
|---|
| 5 | Use this package to easily convert various time formats to milliseconds.
|
|---|
| 6 |
|
|---|
| 7 | ## Examples
|
|---|
| 8 |
|
|---|
| 9 | ```js
|
|---|
| 10 | ms('2 days') // 172800000
|
|---|
| 11 | ms('1d') // 86400000
|
|---|
| 12 | ms('10h') // 36000000
|
|---|
| 13 | ms('2.5 hrs') // 9000000
|
|---|
| 14 | ms('2h') // 7200000
|
|---|
| 15 | ms('1m') // 60000
|
|---|
| 16 | ms('5s') // 5000
|
|---|
| 17 | ms('1y') // 31557600000
|
|---|
| 18 | ms('100') // 100
|
|---|
| 19 | ms('-3 days') // -259200000
|
|---|
| 20 | ms('-1h') // -3600000
|
|---|
| 21 | ms('-200') // -200
|
|---|
| 22 | ```
|
|---|
| 23 |
|
|---|
| 24 | ### Convert from Milliseconds
|
|---|
| 25 |
|
|---|
| 26 | ```js
|
|---|
| 27 | ms(60000) // "1m"
|
|---|
| 28 | ms(2 * 60000) // "2m"
|
|---|
| 29 | ms(-3 * 60000) // "-3m"
|
|---|
| 30 | ms(ms('10 hours')) // "10h"
|
|---|
| 31 | ```
|
|---|
| 32 |
|
|---|
| 33 | ### Time Format Written-Out
|
|---|
| 34 |
|
|---|
| 35 | ```js
|
|---|
| 36 | ms(60000, { long: true }) // "1 minute"
|
|---|
| 37 | ms(2 * 60000, { long: true }) // "2 minutes"
|
|---|
| 38 | ms(-3 * 60000, { long: true }) // "-3 minutes"
|
|---|
| 39 | ms(ms('10 hours'), { long: true }) // "10 hours"
|
|---|
| 40 | ```
|
|---|
| 41 |
|
|---|
| 42 | ## Features
|
|---|
| 43 |
|
|---|
| 44 | - Works both in [Node.js](https://nodejs.org) and in the browser
|
|---|
| 45 | - If a number is supplied to `ms`, a string with a unit is returned
|
|---|
| 46 | - If a string that contains the number is supplied, it returns it as a number (e.g.: it returns `100` for `'100'`)
|
|---|
| 47 | - If you pass a string with a number and a valid unit, the number of equivalent milliseconds is returned
|
|---|
| 48 |
|
|---|
| 49 | ## Related Packages
|
|---|
| 50 |
|
|---|
| 51 | - [ms.macro](https://github.com/knpwrs/ms.macro) - Run `ms` as a macro at build-time.
|
|---|
| 52 |
|
|---|
| 53 | ## Caught a Bug?
|
|---|
| 54 |
|
|---|
| 55 | 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
|
|---|
| 56 | 2. Link the package to the global module directory: `npm link`
|
|---|
| 57 | 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!
|
|---|
| 58 |
|
|---|
| 59 | As always, you can run the tests using: `npm test`
|
|---|
