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.

readme.md 1.7KB

5 vuotta sitten
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. # ms
  2. [![Build Status](https://travis-ci.org/zeit/ms.svg?branch=master)](https://travis-ci.org/zeit/ms)
  3. [![Slack Channel](http://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)
  4. Use this package to easily convert various time formats to milliseconds.
  5. ## Examples
  6. ```js
  7. ms('2 days') // 172800000
  8. ms('1d') // 86400000
  9. ms('10h') // 36000000
  10. ms('2.5 hrs') // 9000000
  11. ms('2h') // 7200000
  12. ms('1m') // 60000
  13. ms('5s') // 5000
  14. ms('1y') // 31557600000
  15. ms('100') // 100
  16. ```
  17. ### Convert from milliseconds
  18. ```js
  19. ms(60000) // "1m"
  20. ms(2 * 60000) // "2m"
  21. ms(ms('10 hours')) // "10h"
  22. ```
  23. ### Time format written-out
  24. ```js
  25. ms(60000, { long: true }) // "1 minute"
  26. ms(2 * 60000, { long: true }) // "2 minutes"
  27. ms(ms('10 hours'), { long: true }) // "10 hours"
  28. ```
  29. ## Features
  30. - Works both in [node](https://nodejs.org) and in the browser.
  31. - If a number is supplied to `ms`, a string with a unit is returned.
  32. - If a string that contains the number is supplied, it returns it as a number (e.g.: it returns `100` for `'100'`).
  33. - If you pass a string with a number and a valid unit, the number of equivalent ms is returned.
  34. ## Caught a bug?
  35. 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
  36. 2. Link the package to the global module directory: `npm link`
  37. 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!
  38. As always, you can run the tests using: `npm test`