sub

Subtract the specified years, months, weeks, days, hours, minutes and seconds from the given date.

Description

Subtract the specified years, months, weeks, days, hours, minutes and seconds from the given date.

Usage

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

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

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

Syntax

sub(date, duration)

Arguments

Name	Description
date	the date to be changed
duration	the object with years, months, weeks, days, hours, minutes and seconds to be subtracted Key Description years Amount of years to be subtracted months Amount of months to be subtracted weeks Amount of weeks to be subtracted days Amount of days to be subtracted hours Amount of hours to be subtracted minutes Amount of minutes to be subtracted seconds Amount of seconds to be subtracted All values default to 0

Returns

Description
the new date with the seconds subtracted

Exceptions

Type	Description
TypeError	2 arguments required

Examples

// Subtract the following duration from 15 June 2017 15:29:20
const result = sub(new Date(2017, 5, 15, 15, 29, 20), {
  years: 2,
  months: 9,
  weeks: 1,
  days: 7,
  hours: 5,
  minutes: 9,
  seconds: 30
})
//=> Mon Sep 1 2014 10:19:50