Skip to content

PlainTime ​

PlainTime represents a clock time without a date or time zone. Addition wraps across midnight and preserves nanosecond precision.

API ​

  • plainTimeFrom(value: string): Result<PlainTime, TemporalError> parses ISO clock text.
  • plainTimeFromFields(fields: PlainTime): Result<PlainTime, TemporalError> validates time fields.
  • plainTimeToString(value: PlainTime): Result<string, TemporalError> formats the clock time.
  • plainTimeEquals(left, right): boolean compares times by value.
  • plainTimeAddSeconds and plainTimeAddNanoseconds return Result<PlainTime, TemporalError> after adding signed clock units with wrapping.
  • plainTimeAddDuration and plainTimeSubtractDuration return Result<PlainTime, TemporalError> after applying a fixed clock Duration.
  • plainTimeUntil and plainTimeSince return signed differences as Result<Duration, TemporalError>.
  • plainTimeUntilWithOptions and plainTimeSinceWithOptions return Result<Duration, TemporalError> and accept largestUnit, smallestUnit, roundingIncrement, and roundingMode.
  • plainTimeSecondsUntil and plainTimeNanosecondsUntil return scalar differences as Result<i64, TemporalError>.
tyrus
import { Duration, PlainTime, plainTimeAddNanoseconds, plainTimeFrom, plainTimeNanosecondsUntil, plainTimeSince, plainTimeSubtractDuration, plainTimeToString, plainTimeUntil, plainTimeUntilWithOptions } from "tyrus:temporal";

const time: PlainTime = match plainTimeFrom("14:30:15.500") { Ok(value) => value, Err(error) => { printError(error.code); return; } };
const text: string = match plainTimeToString(time) { Ok(value) => value, Err(error) => { printError(error.code); return; } }; // "14:30:15.5"
const shiftedTime: PlainTime = match plainTimeAddNanoseconds(time, 750_000_000) { Ok(value) => value, Err(error) => { printError(error.code); return; } };
const nanoseconds: i64 = match plainTimeNanosecondsUntil(time, shiftedTime) { Ok(value) => value, Err(error) => { printError(error.code); return; } }; // 750000000
const duration: Duration = { years: 0, months: 0, weeks: 0, days: 0, hours: 1, minutes: 0, seconds: 0, milliseconds: 0, microseconds: 0, nanoseconds: 0 };
const later: PlainTime = match plainTimeSubtractDuration(shiftedTime, duration) { Ok(value) => value, Err(error) => { printError(error.code); return; } };
const difference: Duration = match plainTimeUntil(time, shiftedTime) { Ok(value) => value, Err(error) => { printError(error.code); return; } };
const elapsed: Duration = match plainTimeSince(shiftedTime, time) { Ok(value) => value, Err(error) => { printError(error.code); return; } };
const rounded: Duration = match plainTimeUntilWithOptions(time, shiftedTime, "hours", "minutes", 15, "halfExpand") { Ok(value) => value, Err(error) => { printError(error.code); return; } }; // 0h 45m