addTime

Signature

addTime(value: string, units: Partial<Record<"hours" | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds", number>>): string

Return a PlainTime ISO string with units added to value.

• Validates value, units, and amount before performing the add.
• Returns "" for invalid inputs. There is no options argument (its only member, overflow, was removed in 1.16.0): Temporal PlainTime#add takes no options and always wraps around the clock (e.g. 23:00 + 2 hours = 01:00).

Parameters

Parameter	Type	Description
value	string	ISO PlainTime string
units	Partial<Record<"hours" | "minutes" | "seconds" | "milliseconds" | "microseconds" | "nanoseconds", number>>	Partial<Record<TimeDurationUnit, number>> object specifying units to add

Returns

ISO PlainTime string after addition, or "" on invalid input

Related types

• TimeDurationUnit

Examples

import { addTime } from "@northguild/gmt/plain/calculate";

addTime("12:00:00", { hours: 1 }) // "13:00:00"

value

output

 

Source

plain/calculate/addTime.ts