getDateIn

Signature

getDateIn(units: Partial<Record<"years" | "months" | "weeks" | "days", number>>): string

Return the PlainDate after today, as an ISO string, counted from the current time.

Reads the clock once, after units is checked.
units is an object of unit amounts (years, months, weeks, days), such as { days: 90 }. A duration string returns "". A time unit returns "", even at zero, as addDate does; use getDateTimeIn or getZonedIn for hours. A fractional amount returns "": use whole days.
Lengths are unsigned: a negative amount returns "". getDateAgo is the way back.
{ days: 0 } is a valid length and gives today, so getDateIn({ days: 0 }) equals getToday().
Counts from today in the system time zone, so a server’s result changes with its zone; getZonedIn names one.
A missing day clamps to the end of the month: 31 January plus a month is 28 February, or 29 in a leap year.
Each call reads the clock. To pin the start, use addDate(getToday(), units).
Examples read the clock at 2027-06-15T12:00:00Z, with the system time zone UTC.

Parameter	Type	Description
`units`	`Partial<Record<"years" \| "months" \| "weeks" \| "days", number>>`	unit amounts, such as `{ days: 90 }`; never negative

ISO PlainDate string, or "" for invalid units, a negative amount, a time unit, an unavailable system zone or a result outside Temporal’s range

import { getDateIn } from "@northguild/gmt/plain/get";

getDateIn({ days: 90 }) // "2027-09-13"

units amount

units unit

output