differenceInMinutes

Get the number of minutes between the given dates.

Description

Get the signed number of full (rounded towards 0) minutes between the given dates.

Usage

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

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

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

Syntax

differenceInMinutes(dateLeft, dateRight, [options])

Arguments

Name	Description
dateLeft	the later date
dateRight	the earlier date
options	an object with options.
options.roundingMethod	a rounding method (ceil, floor, round or trunc)

Returns

Description
the number of minutes

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
const result = differenceInMinutes(
  new Date(2014, 6, 2, 12, 20, 0),
  new Date(2014, 6, 2, 12, 7, 59)
)
//=> 12

// How many minutes are between 10:01:59 and 10:00:00
const result = differenceInMinutes(
  new Date(2000, 0, 1, 10, 0, 0),
  new Date(2000, 0, 1, 10, 1, 59)
)
//=> -1