differenceInMonths

Get the number of full months between the given dates.

Description

Get the number of full months between the given dates using trunc as a default rounding method.

Usage

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

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

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

Syntax

differenceInMonths(dateLeft, dateRight)

Arguments

Name	Description
dateLeft	the later date
dateRight	the earlier date

Returns

Description
the number of full months

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// How many full months are between 31 January 2014 and 1 September 2014?
const result = differenceInMonths(new Date(2014, 8, 1), new Date(2014, 0, 31))
//=> 7