Temporal.Duration.prototype.months

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The months accessor property of Temporal.Duration instances returns an integer representing the number of months in the duration.

Unless the duration is balanced, you cannot assume the range of this value, but you can know its sign by checking the duration's sign property. If it is balanced to a unit above months, the months absolute value's range depends on the calendar (how many months are in a year).

The set accessor of months is undefined. You cannot change this property directly. Use the with() method to create a new Temporal.Duration object with the desired new value.

Examples

Using months

const d1 = Temporal.Duration.from({ years: 1, months: 1 });
const d2 = Temporal.Duration.from({ years: -1, months: -1 });
const d3 = Temporal.Duration.from({ years: 1 });
const d4 = Temporal.Duration.from({ months: 12 });

console.log(d1.months); // 1
console.log(d2.months); // -1
console.log(d3.months); // 0
console.log(d4.months); // 12

// Balance d4
const d4Balanced = d4.round({
  largestUnit: "years",
  relativeTo: Temporal.PlainDate.from("2021-01-01"), // ISO 8601 calendar
});
console.log(d4Balanced.months); // 0
console.log(d4Balanced.years); // 1

Specifications

Specification
Temporal # sec-get-temporal.duration.prototype.months

Browser compatibility

	Desktop					Mobile						Server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	Deno	Node.js
`months`	No	No	139	No	preview	No	139	No	No	No	No	1.40	No

Examples

Using months

Specifications

Browser compatibility

See also