Temporal.Duration.prototype.weeks

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 weeks accessor property of Temporal.Duration instances returns an integer representing the number of weeks 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 weeks, the weeks absolute value's range depends on the calendar (how many weeks are in a month or year).

The set accessor of weeks 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 weeks

const d1 = Temporal.Duration.from({ weeks: 1, days: 1 });
const d2 = Temporal.Duration.from({ weeks: -1, days: -1 });
const d3 = Temporal.Duration.from({ weeks: 1 });
const d4 = Temporal.Duration.from({ days: 7 });

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

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

Specifications

Specification
Temporal proposal # sec-get-temporal.duration.prototype.weeks

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
`weeks`	No	No	No	No	preview	No	No	No	No	No	No	1.40	No

Examples

Using weeks

Specifications

Browser compatibility

See also