https://github.com/cityssm/node-to-millis
Increases the readability of millisecond (and second) values in JavaScript.
https://github.com/cityssm/node-to-millis
days duration hours milliseconds minutes seconds setinterval settimeout time
Last synced: 4 months ago
JSON representation
Increases the readability of millisecond (and second) values in JavaScript.
- Host: GitHub
- URL: https://github.com/cityssm/node-to-millis
- Owner: cityssm
- License: mit
- Created: 2024-10-28T19:06:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-13T16:57:53.000Z (about 1 year ago)
- Last Synced: 2024-11-13T17:40:24.845Z (about 1 year ago)
- Topics: days, duration, hours, milliseconds, minutes, seconds, setinterval, settimeout, time
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@cityssm/to-millis
- Size: 339 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# To Millis
[](https://www.npmjs.com/package/@cityssm/to-millis)
[](https://app.deepsource.com/gh/cityssm/node-to-millis/)
[](https://codecov.io/gh/cityssm/node-to-millis)
[](https://github.com/cityssm/node-to-millis/actions/workflows/coverage.yml)
Increases the readability of millisecond (and second) values in JavaScript.
Handy when used with functions like `setTimeout()` and `setInterval()` to provide easy-to-read durations,
or when adding to times represented in milliseconds.
## Installation
```sh
npm install @cityssm/to-millis
```
## Basic Usage
```javascript
import toMillis from '@cityssm/to-millis'
/*
* With toMillis 👍
*/
setInterval(dailyTask, toMillis(1, 'day'))
const twoHoursFromNow = Date.now() + toMillis(2, 'hours')
/*
* Without toMillis,
* you may expand the calculation to make the amount more readable. 😕
*/
setInterval(dailyTask, 1 * 24 * 60 * 60 * 1000)
const twoHoursFromNow = Date.now() + 2 * 60 * 60 * 1000
```
## More Exports
- `toSeconds(durationAmount, durationUnit)`
Functions without units:
- `daysToMillis(durationDays)`
- `hoursToMillis(durationHours)`
- `minutesToMillis(durationMinutes)`
- `secondsToMillis(durationSeconds)`
- `daysToSeconds(durationDays)`
- `hoursToSeconds(durationHours)`
- `minutesToSeconds(durationMinutes)`
- `millisToSeconds(durationMillis)`
Arrays of acceptable units:
- `durationUnitsDays`
- `durationUnitsHours`
- `durationUnitsMinutes`
- `durationUnitsSeconds`
- `durationUnitsMilliseconds`
Multipliers used for calculations:
- `millisecondsInOneDay`
- `millisecondsInOneHour`
- `millisecondsInOneMinute`
- `millisecondsInOneSecond`
- `secondsInOneDay`
- `secondsInOneHour`
- `secondsInOneMinute`