intervalToDuration

Convert interval to duration

Description

Convert a interval object to a duration object.

Usage

// CommonJS
var intervalToDuration = require('date-fns/intervalToDuration')

// ES 2015
import intervalToDuration from 'date-fns/intervalToDuration'

// ESM
import { intervalToDuration } from 'date-fns'

Syntax

intervalToDuration(interval)

Arguments

Name	Description
interval	the interval to convert to duration

Returns

Description
The duration Object

Exceptions

Type	Description
TypeError	Requires 2 arguments
RangeError	start must not be Invalid Date
RangeError	end must not be Invalid Date

Examples

// Get the duration between January 15, 1929 and April 4, 1968.
intervalToDuration({
  start: new Date(1929, 0, 15, 12, 0, 0),
  end: new Date(1968, 3, 4, 19, 5, 0)
})
// => { years: 39, months: 2, days: 20, hours: 7, minutes: 5, seconds: 0 }