subtractDateTime

Signature

subtractDateTime(value: string, units: Partial<Record<keyof DurationLike, number>>, options?: { overflow?: "reject" | "constrain" | undefined; }): string

Return a PlainDateTime ISO string with units subtracted from value.

• Validates value, units, and amount before performing the subtract.
• Returns "" for invalid inputs.

Parameters

Parameter	Type	Description
value	string	ISO PlainDateTime string
units	Partial<Record<keyof DurationLike, number>>	Partial<Record<DateTimeDurationUnit, number>> object specifying units to subtract

Options

options

How an out-of-range result is handled

Option	Type	Default	Description
overflow?	"reject" | "constrain" (Overflow)	"constrain", Temporal’s default.	What to do when the result is not a real date. "constrain" clamps it to the last valid day, so Mar 31 - 1 month is Feb 29 or 28; "reject" returns "".

Returns

ISO PlainDateTime string after subtraction, or "" on invalid input

Related types

• DateTimeDurationUnit
• Overflow

Examples

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

subtractDateTime("2024-03-15T12:00:00", { days: 5 }) // "2024-03-10T12:00:00"

value

output

 

Source

plain/calculate/subtractDateTime.ts