dration
pronounced "duration"
A dependency-free JavaScript library for working with durations/time spans using pure functions and primitive types, written in TypeScript.
Install
With npm
:
npm install dration
Or with yarn
yarn add dration
There are also UMD and ES Modules builds in lib/
. The entire library is tree-shakeable, and has the proper configurations in package.json
for bundlers like Webpack to pick it up.
Usage
The functions are pure and work with milliseconds. The benefit of this is you don't need "add", "subtract", "greater than" and "equals"-style functions; just use regular JavaScript!
console.logvalue // 120000console.logtypeof value // "number" // `fromMinutes` is a shortcut to creating a duration of 2 minutesconsole.lognewValue // 240000console.logDuration.formatnewValue // 00:04:00 // A nice bonus of just using numbers, you can add a duration to a date quite easily:
API
The functions exposed by dration are quite simple and all follow the same form. When referring to a "duration", it means a numeric value in milliseconds.
of(ms: number, s?: number, m?: number, h?: number, d?: number): number
Probably the most important function, converts individual time components to a duration. Leaving any arguments out is the same as passing 0
.
The arguments are:
- milliseconds
- seconds
- minutes
- hours
- days
from
functions
The There are from
functions for each unit, and they all take a single parameter, the amount:
fromSeconds(seconds: number): number
fromMinutes(minutes: number): number
fromHours(hours: number): number
fromDays(days: number): number
between(left: Date, right: Date): number
Returns the duration (milliseconds) between 2 dates.
console.logvalue // 1 02:00:00
format(duration: number): string
Formats a duration to a string in d hh:mm:ss.sss
format, with days and milliseconds left out if zero.
console.log format of50, 4, 33, 2, 1 // "1 02:33:04.050"
Author
Jeff Hansen — @Jeffijoe