You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
# ms

Use this package to easily convert various time formats to milliseconds.
## Examples
```jsms('2 days') // 172800000ms('1d') // 86400000ms('10h') // 36000000ms('2.5 hrs') // 9000000ms('2h') // 7200000ms('1m') // 60000ms('5s') // 5000ms('1y') // 31557600000ms('100') // 100ms('-3 days') // -259200000ms('-1h') // -3600000ms('-200') // -200```
### Convert from Milliseconds
```jsms(60000) // "1m"ms(2 * 60000) // "2m"ms(-3 * 60000) // "-3m"ms(ms('10 hours')) // "10h"```
### Time Format Written-Out
```jsms(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 both in [Node.js](https://nodejs.org) and in 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](https://github.com/knpwrs/ms.macro) - Run `ms` as a macro at build-time.
## Caught a Bug?
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 device2. 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`
|