subYears

Subtract the specified number of years from the given date.

Description

Subtract the specified number of years from the given date.

Usage

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

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

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

Syntax

subYears(date, amount)

Arguments

Name	Description
date	the date to be changed
amount	the amount of years to be subtracted. Positive decimals will be rounded using Math.floor, decimals less than zero will be rounded using Math.ceil.

Returns

Description
the new date with the years subtracted

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Subtract 5 years from 1 September 2014:
const result = subYears(new Date(2014, 8, 1), 5)
//=> Tue Sep 01 2009 00:00:00