Temporal.PlainTime.compare()
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 Temporal.PlainTime.compare()
static method returns a number (-1, 0, or 1) indicating whether the first time comes before, is the same as, or comes after the second time. It is equivalent to comparing the hour, minute, second, millisecond, microsecond, and nanosecond fields one by one.
Syntax
Temporal.PlainTime.compare(time1, time2)
Parameters
time1
-
A string, an object, or a
Temporal.PlainTime
instance representing the first time to compare. It is converted to aTemporal.PlainTime
object using the same algorithm asTemporal.PlainTime.from()
. time2
-
The second time to compare, converted to a
Temporal.PlainTime
object using the same algorithm astime1
.
Return value
Returns -1
if time1
comes before time2
, 0
if they are the same, and 1
if time2
comes after.
Examples
Using Temporal.PlainTime.compare()
const time1 = Temporal.PlainTime.from("12:34:56");
const time2 = Temporal.PlainTime.from("12:34:57");
console.log(Temporal.PlainTime.compare(time1, time2)); // -1
const time3 = Temporal.PlainTime.from("11:34:56");
console.log(Temporal.PlainTime.compare(time1, time3)); // 1
Sorting an array of times
The purpose of this compare()
function is to act as a comparator to be passed to Array.prototype.sort()
and related functions.
const times = ["12:34:56", "11:34:56", "12:34:57"];
times.sort(Temporal.PlainTime.compare);
console.log(times);
// [ "11:34:56", "12:34:56", "12:34:57" ]
Specifications
Specification |
---|
Temporal proposal # sec-temporal.plaintime.compare |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
compare |
Legend
Tip: you can click/tap on a cell for more information.
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- User must explicitly enable this feature.