https://github.com/icholy/duration.js

https://github.com/icholy/duration.js

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/icholy/duration.js
• Owner: icholy
• License: mit
• Created: 2013-07-31T22:26:17.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T17:12:47.000Z (4 months ago)
• Last Synced: 2024-09-28T12:38:13.485Z (5 days ago)
• Language: TypeScript
• Homepage:
• Size: 136 KB
• Stars: 185
• Watchers: 8
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Duration [![Build Status](https://travis-ci.org/icholy/Duration.js.png?branch=master)](https://travis-ci.org/icholy/Duration.js)

This is a library for dealing with durations. 

It works well with javascript's Date objects.

``` sh

$ npm install @icholy/duration

```

``` js

import Duration from "@icholy/duration";

```

### Parse

* `ms` - millisecond

* `s` - second

* `m` - minute

* `h` - hour

* `d` - day

* `w` - week

``` js

var d = new Duration("6w5d4h3m2s1ms");

console.log(

    d.milliseconds(), "\n", // => 4075382001

    d.seconds(),      "\n", // => 4075382

    d.minutes(),      "\n", // => 67923

    d.hours(),        "\n", // => 1132

    d.days(),         "\n", // => 47

    d.weeks(),        "\n"  // => 6

);

```

### Format

``` js

console.log(

  "str:",  Duration.hour.toString(),

  "ms:",   Duration.hour.valueOf()

); // => "str: 1h ms: 3600000"

```

### Basic Operations

``` js

// Addition

var d1 = new Duration("6d"),

    d2 = new Duration(d1 + Duration.day);

console.log(d2.toString()) // => "168h"

// Multiplication

var d3 = new Duration("5m"),

    d4 = new Duration(d3 * 12);

console.log(d4.toString()) // => "1h"

// etc ...

```

### Dates

``` js

// Adding duration to date

var d     = Duration.parse("5h"),

    now   = new Date(),

    later = new Date(now + d);

console.log(later.toString());

// Duration between two dates

var bday = new Date("March 3, 1991"),

    now  = new Date(),

    age  = new Duration(now - bday);

console.log(age.toString());

```

### setTimeout / setInterval

``` js

setTimeout(function () {

    // runs 5 minutes later

}, new Duration("5m"));

setInterval(function () {

    // runs every 10 seconds 

}, 10 * Duration.second);

```