forked from FINAKON/HelpProject
1. Initial Commit - a boiler plate code and POC to realize the concept of context sensitive help 2. Frontend code written in ReactJS 3. Backend code written in Java, Spring Boot Framework 4. Frontend Start: pre-requisites : node, npm npm run dev ==> to start the frontend vite server 5. Backend Start: pre-requisites : java, mvn mvn spring-boot:run ==> to start the backend server 6. Visit http://localhost:5173/ for basic demo of help, press F1 in textboxes 7. Visit http://localhost:5173/editor and enter "admin123" to add/modify texts. Happy Coding !!! Thank you, Bhargava.
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
# ms
|
|
|
|

|
|
|
|
Use this package to easily convert various time formats to milliseconds.
|
|
|
|
## Examples
|
|
|
|
```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
|
|
ms('1y') // 31557600000
|
|
ms('100') // 100
|
|
ms('-3 days') // -259200000
|
|
ms('-1h') // -3600000
|
|
ms('-200') // -200
|
|
```
|
|
|
|
### Convert from Milliseconds
|
|
|
|
```js
|
|
ms(60000) // "1m"
|
|
ms(2 * 60000) // "2m"
|
|
ms(-3 * 60000) // "-3m"
|
|
ms(ms('10 hours')) // "10h"
|
|
```
|
|
|
|
### Time Format Written-Out
|
|
|
|
```js
|
|
ms(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 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.js will now use your clone of ms!
|
|
|
|
As always, you can run the tests using: `npm test`
|