github.com/jfrog/frogbot@v1.1.1-0.20231221090046-821a26f50338/action/node_modules/ms/readme.md (about)

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