subDays

Subtract the specified number of days from the given date.

Description

Subtract the specified number of days from the given date.

Usage

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

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

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

Syntax

subDays(date, amount)

Arguments

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

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Subtract 10 days from 1 September 2014:
const result = subDays(new Date(2014, 8, 1), 10)
//=> Fri Aug 22 2014 00:00:00