differenceInCalendarDays

Get the number of calendar days between the given dates.

Description

Get the number of calendar days between the given dates. This means that the times are removed from the dates and then the difference in days is calculated.

Usage

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

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

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

Syntax

differenceInCalendarDays(dateLeft, dateRight)

Arguments

Name	Description
dateLeft	the later date
dateRight	the earlier date

Returns

Description
the number of calendar days

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// How many calendar days are between
// 2 July 2011 23:00:00 and 2 July 2012 00:00:00?
const result = differenceInCalendarDays(
  new Date(2012, 6, 2, 0, 0),
  new Date(2011, 6, 2, 23, 0)
)
//=> 366
// How many calendar days are between
// 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
const result = differenceInCalendarDays(
  new Date(2011, 6, 3, 0, 1),
  new Date(2011, 6, 2, 23, 59)
)
//=> 1