vnfmarket/src/main/webapp/vnfmarket/node_modules/method-override/node_modules/ms/README.md

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