differenceInYears

Get the number of full years between the given dates.

Description

Get the number of full years between the given dates.

Usage

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

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

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

Syntax

differenceInYears(dateLeft, dateRight)

Arguments

Name	Description
dateLeft	the later date
dateRight	the earlier date

Returns

Description
the number of full years

Exceptions

Type	Description
TypeError	2 arguments required

Examples

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