subMonths

Subtract the specified number of months from the given date.

Description

Subtract the specified number of months from the given date.

Usage

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

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

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

Syntax

subMonths(date, amount)

Arguments

Name	Description
date	the date to be changed
amount	the amount of months 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 months subtracted

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Subtract 5 months from 1 February 2015:
const result = subMonths(new Date(2015, 1, 1), 5)
//=> Mon Sep 01 2014 00:00:00