2017-04-20 03:09:25 +02:00
# ms
[![Build Status ](https://travis-ci.org/zeit/ms.svg?branch=master )](https://travis-ci.org/zeit/ms)
2017-05-24 15:10:37 +02:00
[![Slack Channel ](http://zeit-slackin.now.sh/badge.svg )](https://zeit.chat/)
2017-04-20 03:09:25 +02:00
Use this package to easily convert various time formats to milliseconds.
## Examples
2016-10-10 03:43:44 +02:00
```js
ms('2 days') // 172800000
ms('1d') // 86400000
ms('10h') // 36000000
ms('2.5 hrs') // 9000000
ms('2h') // 7200000
ms('1m') // 60000
ms('5s') // 5000
2017-04-20 03:09:25 +02:00
ms('1y') // 31557600000
2016-10-10 03:43:44 +02:00
ms('100') // 100
```
2017-04-20 03:09:25 +02:00
### Convert from milliseconds
2016-10-10 03:43:44 +02:00
```js
ms(60000) // "1m"
ms(2 * 60000) // "2m"
ms(ms('10 hours')) // "10h"
```
2017-04-20 03:09:25 +02:00
### Time format written-out
2016-10-10 03:43:44 +02:00
```js
ms(60000, { long: true }) // "1 minute"
ms(2 * 60000, { long: true }) // "2 minutes"
ms(ms('10 hours'), { long: true }) // "10 hours"
```
2017-04-20 03:09:25 +02:00
## Features
- Works both in [node ](https://nodejs.org ) and in the browser.
2016-10-10 03:43:44 +02:00
- If a number is supplied to `ms` , a string with a unit is returned.
2017-04-20 03:09:25 +02:00
- 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 ms is returned.
## Caught a bug?
2016-10-10 03:43:44 +02:00
2017-04-20 03:09:25 +02:00
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
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 will now use your clone of ms!
2016-10-10 03:43:44 +02:00
2017-04-20 03:09:25 +02:00
As always, you can run the tests using: `npm test`