addYears

Prev Next

Description

Returns a DateTime object with a specified number of years added to today's date. Both positive and negative values are supported to either add or subtract the specified amount of time.


Input Parameters

Name Type Required Description
value Number Yes Number of years to add or subtract

Returns

Type: DateTime

Returns a new DateTime value with the adjusted time component.


Examples

// returns a new DateTime with 1 year added from today
var date = tools.addYears(1);
JavaScript
// returns a new DateTime with 1 year subtracted from today
var date = tools.addYears(-1);
JavaScript

Remarks

Use this helper function when you want to create offset DateTime values computed from today's date and time.