https://github.com/alorel/node-ms-util
Converting millis to a human-readable string is a pain. It doesn't have to be.
https://github.com/alorel/node-ms-util
Last synced: 28 days ago
JSON representation
Converting millis to a human-readable string is a pain. It doesn't have to be.
- Host: GitHub
- URL: https://github.com/alorel/node-ms-util
- Owner: Alorel
- License: mit
- Created: 2017-01-19T12:46:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-14T19:09:29.000Z (over 7 years ago)
- Last Synced: 2025-03-07T16:41:39.589Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 31.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/Alorel/node-ms-util)
[](https://coveralls.io/github/Alorel/node-ms-util?branch=master)
[](https://www.npmjs.com/package/ms-util/)
Converting millis to a human-readable string is a pain. It doesn't have to be.
# Table of contents
- [Related packages](#related-packages)
- [Base usage](#base-usage)
- [Browser](#browser)
- [NodeJS](#nodejs)
- [API](#api)
- [parse](#parse)
- [toWords](#towords)
- [colonSeparated](#colonseparated)
# Related packages
You might want to check out the [ms](https://www.npmjs.com/package/ms) package. There are two *main* differences:
- It **can** convert a string to millis
- It **can't** display more than one unit, i.e. `3,660,000` ms would be converted to one hour, not one hour and one minute.
# Base usage
Note: play around with it on [Runkit](https://runkit.com/npm/ms-util)!
## Browser
It's always best to use a specific version - you'll find the CDN URLs [here](https://www.jsdelivr.com/projects/ms-util).
```html
```
## NodeJS
```js
const parseMs = require('ms-util');
```
# API
## parse
Parse the given millis and return the number of days, hours, minutes seconds and ms they translate to.
```js
console.log(parseMs.parse(86407049));
```
```json
{
"days": 1,
"hours": 0,
"minutes": 0,
"seconds": 7,
"millis": 49,
"input": 86407049
}
```
## toWords
Parse the given millis to a word string, e.g. 3660000 ms would become 01hr 01min 00sec by default.
Function signature:
```js
parseMs.toWords = (ms, cfg = {}) => {};
```
Where `ms` is the millis you want to convert and cfg is configuration with the following keys:
- **pad**: Whether to pad numbers with zeroes or not. Default: `true`.
- **forceMS**: Force displaying millis even if `ms` is >= `1000`. Default: `false`.
- **lang**: Language pack override. The default is:
```json
{
"ms": "ms",
"sec": "sec",
"min": "min",
"hour": "hr",
"day": "d"
}
```
Usage:
```js
console.log(parseMs.toWords(86407049)); // 1d 00hr 00min 07sec
```
## colonSeparated
Parse the given millis to a colon-separated string, e.g. 3660000 ms would become 01:01:00 by default
Function signature:
```js
parseMs.colonSeparated = (ms, cfg = {}) => {};
```
Where `ms` is the millis you want to convert and cfg is configuration with the following keys:
- **pad**: Whether to pad numbers with zeroes or not. Default: `true`.
- **forceMS**: Force displaying millis even if `ms` is >= `1000`. Default: `false`.
Usage:
```js
console.log(parseMs.colonSeparated(86407049)); // 1:00:00:07
```