Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabricio-191/ms
Tiny millisecond conversion utility
https://github.com/fabricio-191/ms
conversion language milisecond parse utility
Last synced: about 2 months ago
JSON representation
Tiny millisecond conversion utility
- Host: GitHub
- URL: https://github.com/fabricio-191/ms
- Owner: Fabricio-191
- License: apache-2.0
- Created: 2021-03-14T23:36:22.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T10:11:47.000Z (over 1 year ago)
- Last Synced: 2024-11-07T18:01:39.469Z (2 months ago)
- Topics: conversion, language, milisecond, parse, utility
- Language: JavaScript
- Homepage:
- Size: 257 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://discord.gg/zrESMn6)
[](https://github.com/Fabricio-191/ms/actions/workflows/node.js.yml)
# @fabricio-191/ms
A powerful tool for parsing times formats and durations into its respective value in milliseconds.
And also for converting milliseconds into an human readable format.
### Differences with [ms](https://www.npmjs.com/package/ms)
```diff
+ Can parse multiple languages
+ Can parse multiple units
+ Formatting has more options
+ Does not round while formatting
- When formatting, it's way slower than ms
```
## Parse
If nothing can be parsed, it returns `null`
```js
const ms = require('@fabricio-191/ms');
ms('2 hours, 5.5 minutes and .3s'); // 7530300
ms('1 week 2 days'); // 777600000
ms('2 days 1 hour'); // 176400000
ms('1m10secs'); // 70000
ms('5s50ms'); // 5050
ms('1y'); // 31557600000
ms('1d'); // 86400000
ms('10h'); // 36000000
ms('2.5 hrs'); // 9000000
ms('.5m'); // 30000
ms('100'); // 100
ms('0 seconds'); // 0
ms('-.5 mins'); // -30000
ms('- 2m 30s'); // -150000
ms('-3 days'); // -259200000
ms.clock('2:09:00'); // 7740000 (hh:mm:ss)
ms.clock('3:10'); // 11400000 (hh:mm)
ms.clock('3:10', true); // 190000 (mm:ss)
// english is the default language
ms('1 day', 'es'); // null (wrong language)
ms('1 dia', 'es'); // 86400000
ms('1 日', 'ja'); // 86400000
ms('12 seconds', ['en', 'es']); // 12000 (english)
ms('-3 minutos', ['en', 'es']); // -180000 (spanish)
ms('-3 分', ['en', 'es']); // null
ms('2 minutes 15 seconds', 'all'); // 135000
ms('2 minutos 15 segundos', 'all'); // 135000
ms('2 分 15 秒', 'all'); // 135000
```
## Format
```js
const num = ms('16 days 8 hours 20 mins 40 secs');
ms(num); // default length is 3 // 16d 8h 20m
ms(num, { length: 2 }); // 16d 8h
ms(num, { length: 8 }); // 16d 8h 20m 40s
ms(num, { long: true }); // 16 days 8 hours 20 minutes
ms(num, { long: true, language: 'es' }); // 16 dias 8 horas 20 minutos
ms(num, { language: 'ja' }); // 16日 8時間 20分
```
### Formats
* `Y`: year
* `Mo`: month
* `W`: week
* `D`: day
* `H`: hour
* `M`: minute
* `S`: second
* `Ms`: milisecond
```js
ms(num); // 16d 8h 20m
ms(num, { format: 'HS' }); // 392h 1240s
ms(4100940000, { format: 'WDHM', length: 2 }); // 6w 5d
ms(4100940000, { format: 'WDHM', length: 4 }); // 6w 5d 11h 9m
ms(10, { format: 'HS' }); // 0s (too small)
```
The default format is `YMoDHMSMs` (without weeks)
## Supported languages
```js
'en' => 'English'
'es' => 'Spanish'
'ja' => 'Japanese'
```
You can add a language dynamically by using the `addLanguage` method. [here](https://github.com/Fabricio-191/ms/blob/master/docs/AddLanguage.md) is the documentation.
Extra
Execute this, it looks nice
```js
const ms = require('@fabricio-191/ms'), start = ms('1970 years 1 month');
setInterval(() => {
process.stdout.clearLine(0);
process.stdout.cursorTo(0);
process.stdout.write(ms(Date.now() + start, { length: 8 }));
process.stdout.cursorTo(31);
}, 1);
```