differenceInCalendarYears

Get the number of calendar years between the given dates.

Description

Get the number of calendar years between the given dates.

Usage

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

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

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

Syntax

differenceInCalendarYears(dateLeft, dateRight)

Arguments

Name	Description
dateLeft	the later date
dateRight	the earlier date

Returns

Description
the number of calendar years

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// How many calendar years are between 31 December 2013 and 11 February 2015?
const result = differenceInCalendarYears(
  new Date(2015, 1, 11),
  new Date(2013, 11, 31)
)
//=> 2