Temporal.PlainTime.prototype.with()
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 with() method of Temporal.PlainTime instances returns a new Temporal.PlainTime object representing this time with some fields replaced by new values. Because all Temporal objects are designed to be immutable, this method essentially functions as the setter for the time's fields.
Syntax
with(info)
with(info, options)
Parameters
info-
An object containing at least one of the properties recognized by
Temporal.PlainTime.from():hour,microsecond,millisecond,minute,nanosecond,second. Unspecified properties use the values from the original time. optionsOptional-
An object containing the following property:
overflowOptional-
A string specifying the behavior when a time component is out of range. Possible values are:
"constrain"(default)-
The time component is clamped to the valid range.
"reject"-
A
RangeErroris thrown if the time component is out of range.
Return value
A new Temporal.PlainTime object, where the fields specified in info that are not undefined are replaced by the corresponding values, and the rest of the fields are copied from the original time.
Exceptions
TypeError-
Thrown in one of the following cases:
infois not an object with at least one recognized property or a string.optionsis not an object orundefined.
RangeError-
Thrown if the provided numerical properties are out of range, and
options.overflowis set to"reject".
Examples
Using with()
const time = Temporal.PlainTime.from("12:34:56.123456789");
const newTime = time.with({ hour: 23 });
console.log(newTime.toString()); // '23:34:56.123456789'
For more examples, see the documentation for the individual properties that can be set using with().
Specifications
| Specification |
|---|
| Temporal # sec-temporal.plaintime.prototype.with |
Browser compatibility
Loading…