subWeeks

Subtract the specified number of weeks from the given date.

Description

Subtract the specified number of weeks from the given date.

Usage

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

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

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

Syntax

subWeeks(date, amount)

Arguments

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

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Subtract 4 weeks from 1 September 2014:
const result = subWeeks(new Date(2014, 8, 1), 4)
//=> Mon Aug 04 2014 00:00:00