addMonths
- 09 Apr 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
addMonths
- Updated on 09 Apr 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
Returns a DateTime object with a specified number of months 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 months to add or subtract |
Returns
Type: DateTime
Returns a new DateTime value with the adjusted time component.
Examples
// returns a new DateTime with 3 months added from today
var date = tools.addMonths(3);
// returns a new DateTime with 3 months subtracted from today
var date = tools.addMonths(-3);
Remarks
Use this helper function when you want to create offset DateTime values computed from today's date and time.