@northguild/gmt 1.17.0 → 1.19.0

package/dist/unix/calculate/endOfQuarterForUnix.d.ts

@@ -9,11 +9,15 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  *   takes neither. Those ignored options were removed in 1.16.0.
  * - Returns null for invalid input.
  * - `value` is a safe integer or a digit string (`"1706659200000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC")
+ * @param options optional: how `value` is read and the zone the quarter is found in
  * @returns Unix epoch number representing the end of the quarter, or null on invalid input
  *
  * @example endOfQuarterForUnix(1706659200000, { timeZone: "UTC" }) // 1711929599999
@@ -22,6 +26,20 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example endOfQuarterForUnix(NaN) // null
  */
 export declare function endOfQuarterForUnix(value: number | string, options?: {
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `null`. The result is in the same unit.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * The time zone the unit boundaries are found in: an IANA name, a UTC offset (a time zone
+     * identifier such as `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what
+     * `getTimeZoneOffset` returns), or `"local"` for the system time zone. An unknown zone returns
+     * `null`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
 }): number | null;

package/dist/unix/calculate/endOfQuarterForUnix.js

@@ -10,11 +10,15 @@ import { isOptionsArgument } from "../../internal/isObject.js";
  *   takes neither. Those ignored options were removed in 1.16.0.
  * - Returns null for invalid input.
  * - `value` is a safe integer or a digit string (`"1706659200000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC")
+ * @param options optional: how `value` is read and the zone the quarter is found in
  * @returns Unix epoch number representing the end of the quarter, or null on invalid input
  *
  * @example endOfQuarterForUnix(1706659200000, { timeZone: "UTC" }) // 1711929599999

package/dist/unix/calculate/endOfUnix.d.ts

@@ -8,15 +8,18 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * - Returns the last millisecond of the real local `unit` containing `value` in `timeZone` — just before the next bucket `floorToZone` would return — so the result is never before `value`: the second pass of a repeated fall-back hour ends at its own 1:59:59.999.
  * - Takes no `disambiguation` or `offset`: a boundary is always a real instant, as TC39's `startOfDay()`
  *   takes neither. Those ignored options were removed in 1.16.0.
- * - `weekStartsOn` other than `"monday"` or `"sunday"` returns null, for every unit.
  * - Returns null for invalid input.
  * - `value` is a safe integer or a digit string (`"1706659200000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
  * @param unit Temporal.DateUnit | Temporal.TimeUnit to specify the end
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC"), weekStartsOn ("monday" | "sunday")
+ * @param options optional: how `value` is read, the zone the unit is found in and the first day of the week
  * @returns Unix epoch number representing the end of the unit, or null on invalid input
  *
  * @example endOfUnix(1706659200000, "year", { timeZone: "UTC" }) // 1735689599999
@@ -27,9 +30,31 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example endOfUnix(1706780800, "days", { epochUnit: "second" }) // 1706831999 (plural unit, singular epochUnit, UTC by default)
  * @example endOfUnix(1706659200000, "quarter") // null (use endOfQuarterForUnix)
  * @example endOfUnix(NaN, "day") // null
+ * @example endOfUnix(45870000, "day", { timeZone: "-00:44:30" }) // 89069999 (a stored offset with seconds)
  */
 export declare function endOfUnix(value: number | string, unit: Temporal.DateTimeUnit | Temporal.PluralUnit<Temporal.DateTimeUnit>, options?: {
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `null`. The result is in the same unit.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * The time zone the unit boundaries are found in: an IANA name, a UTC offset (a time zone
+     * identifier such as `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what
+     * `getTimeZoneOffset` returns), or `"local"` for the system time zone. An unknown zone returns
+     * `null`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
+    /**
+     * The first day of the week, which sets where a `"week"` unit starts. `"monday"` is the ISO
+     * 8601 week, Monday to Sunday; `"sunday"` runs Sunday to Saturday. Any other value returns
+     * null, whatever the unit.
+     *
+     * @defaultValue `"monday"`
+     */
     weekStartsOn?: "monday" | "sunday";
 }): number | null;

package/dist/unix/calculate/endOfUnix.js

@@ -10,15 +10,18 @@ import { isOptionsArgument } from "../../internal/isObject.js";
  * - Returns the last millisecond of the real local `unit` containing `value` in `timeZone` — just before the next bucket `floorToZone` would return — so the result is never before `value`: the second pass of a repeated fall-back hour ends at its own 1:59:59.999.
  * - Takes no `disambiguation` or `offset`: a boundary is always a real instant, as TC39's `startOfDay()`
  *   takes neither. Those ignored options were removed in 1.16.0.
- * - `weekStartsOn` other than `"monday"` or `"sunday"` returns null, for every unit.
  * - Returns null for invalid input.
  * - `value` is a safe integer or a digit string (`"1706659200000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
  * @param unit Temporal.DateUnit | Temporal.TimeUnit to specify the end
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC"), weekStartsOn ("monday" | "sunday")
+ * @param options optional: how `value` is read, the zone the unit is found in and the first day of the week
  * @returns Unix epoch number representing the end of the unit, or null on invalid input
  *
  * @example endOfUnix(1706659200000, "year", { timeZone: "UTC" }) // 1735689599999
@@ -29,6 +32,7 @@ import { isOptionsArgument } from "../../internal/isObject.js";
  * @example endOfUnix(1706780800, "days", { epochUnit: "second" }) // 1706831999 (plural unit, singular epochUnit, UTC by default)
  * @example endOfUnix(1706659200000, "quarter") // null (use endOfQuarterForUnix)
  * @example endOfUnix(NaN, "day") // null
+ * @example endOfUnix(45870000, "day", { timeZone: "-00:44:30" }) // 89069999 (a stored offset with seconds)
  */
 export function endOfUnix(value, unit, options) {
     try {

package/dist/unix/calculate/isBetweenUnix.d.ts

@@ -4,15 +4,12 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  *
  * - Uses Temporal.Instant.compare for comparison.
  * - Returns false if start > end or inputs are invalid.
- * - Use options.inclusiveStart/inclusiveEnd to control boundaries.
  * - Each value is a safe integer or a digit string (`"1705000000000"`); anything else returns false.
- * - `timeZone` is only validated (the comparison is on exact instants): omitted is UTC, `"local"`
- *   the system zone, and an unknown zone returns false.
  *
  * @param value Unix epoch to check: a safe integer, or a string of optionally negative ASCII digits
  * @param start Unix epoch for range start, in the same form and unit
  * @param end Unix epoch for range end, in the same form and unit
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC" — only validated, the comparison is on exact instants), inclusiveStart (boolean), inclusiveEnd (boolean)
+ * @param options optional: how the epochs are read and whether each end of the range is included
  * @returns boolean indicating whether value is between start and end
  *
  * @example isBetweenUnix(1705000000000, 1704000000000, 1706000000000) // true
@@ -22,8 +19,34 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example isBetweenUnix(1705000000000, 1704000000000, 1706000000000, { timeZone: "Mars/Olympus" }) // false (unknown zone)
  */
 export declare function isBetweenUnix(value: number | string, start: number | string, end: number | string, options?: {
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `false`.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * A time zone that is validated only: the comparison is on exact instants, so the zone never
+     * changes the result. It is an IANA name, a UTC offset (a time zone identifier such as
+     * `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what `getTimeZoneOffset`
+     * returns), or `"local"` for the system time zone. An unknown zone returns `false`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
+    /**
+     * Whether `value` equal to `start` counts as inside the range. `false` requires it to be after
+     * `start`.
+     *
+     * @defaultValue `true`
+     */
     inclusiveStart?: boolean;
+    /**
+     * Whether `value` equal to `end` counts as inside the range. `false` requires it to be before
+     * `end`.
+     *
+     * @defaultValue `true`
+     */
     inclusiveEnd?: boolean;
 }): boolean;

package/dist/unix/calculate/isBetweenUnix.js

@@ -1,22 +1,20 @@
 // fallow-ignore-file code-duplication -- cross-family Temporal type clone, by design (rule 5)
 import { Temporal } from "@js-temporal/polyfill";
-import { normalizeTimeZone } from "../../internal/normalizeTimeZone.js";
+import { normalizeZoneFrame } from "../../internal/zoneFrame.js";
 import { resolveUnixEpochUnit, unixEpochToInstant, } from "../../internal/unixEpochValue.js";
 import { isOptionsArgument } from "../../internal/isObject.js";
+import { optionOrDefault } from "../../internal/optionOrDefault.js";
 /**
  * Return true when the Unix timestamp is between start and end (inclusive by default).
  *
  * - Uses Temporal.Instant.compare for comparison.
  * - Returns false if start > end or inputs are invalid.
- * - Use options.inclusiveStart/inclusiveEnd to control boundaries.
  * - Each value is a safe integer or a digit string (`"1705000000000"`); anything else returns false.
- * - `timeZone` is only validated (the comparison is on exact instants): omitted is UTC, `"local"`
- *   the system zone, and an unknown zone returns false.
  *
  * @param value Unix epoch to check: a safe integer, or a string of optionally negative ASCII digits
  * @param start Unix epoch for range start, in the same form and unit
  * @param end Unix epoch for range end, in the same form and unit
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC" — only validated, the comparison is on exact instants), inclusiveStart (boolean), inclusiveEnd (boolean)
+ * @param options optional: how the epochs are read and whether each end of the range is included
  * @returns boolean indicating whether value is between start and end
  *
  * @example isBetweenUnix(1705000000000, 1704000000000, 1706000000000) // true
@@ -31,14 +29,14 @@ export function isBetweenUnix(value, start, end, options) {
             return false;
         }
         const epochUnit = resolveUnixEpochUnit(options?.epochUnit);
-        const timeZone = normalizeTimeZone(options?.timeZone);
+        const frame = normalizeZoneFrame(options?.timeZone);
         // Only an omitted flag takes the `true` default. An explicit `null` is a value, and every
         // reading of it gives `false`: ECMA-402 reads a boolean option through ToBoolean (null → false),
         // and the house rule rejects an invalid member outright — neither yields `true`. So `null`
         // behaves here exactly as `0` and `""` already do.
-        const inclusiveStart = options?.inclusiveStart === undefined ? true : options.inclusiveStart;
-        const inclusiveEnd = options?.inclusiveEnd === undefined ? true : options.inclusiveEnd;
-        if (!timeZone || epochUnit === null)
+        const inclusiveStart = optionOrDefault(options?.inclusiveStart, true);
+        const inclusiveEnd = optionOrDefault(options?.inclusiveEnd, true);
+        if (frame === null || epochUnit === null)
             return false;
         const instant = unixEpochToInstant(value, epochUnit);
         const startInstant = unixEpochToInstant(start, epochUnit);

package/dist/unix/calculate/roundUnix.d.ts

@@ -14,12 +14,16 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  *   1727532300000 (03:50+13:45) truncated to the hour gives 1727532900000, 15 minutes later.
  *   Use `floorToZone` for a boundary that never exceeds the instant.
  * - `value` is a safe integer or a digit string (`"1706661000000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
  * - Returns null for invalid input.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
- * @param options Rounding options: smallestUnit, optional roundingIncrement, roundingMode, epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC")
+ * @param options rounding settings: the unit to round to, how to round, and how `value` is read
  * @returns Rounded Unix epoch number, or null on invalid input
  *
  * @example roundUnix(1706661000000, { smallestUnit: "hour", timeZone: "UTC" }) // 1706662800000 (00:30 is a tie; halfExpand rounds up)
@@ -33,9 +37,41 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example roundUnix(NaN, { smallestUnit: "hour" }) // null
  */
 export declare function roundUnix(value: number | string, options: {
+    /**
+     * The unit to round to, from `"day"` down to `"nanosecond"`, singular or plural. A larger unit
+     * returns `null`, as `Temporal.ZonedDateTime.prototype.round` accepts none above `"day"`.
+     */
     smallestUnit: Temporal.SmallestUnit<"day" | "hour" | "minute" | "second" | "millisecond" | "microsecond" | "nanosecond">;
+    /**
+     * The number of `smallestUnit` steps to round to, such as `15` with `"minute"` for quarter
+     * hours. It must divide the next larger unit evenly and be smaller than it, and must be `1` for
+     * `"day"`; any other value returns `null`. A non-integer is truncated first, as Temporal does.
+     *
+     * @defaultValue `1`, Temporal's default.
+     */
     roundingIncrement?: number;
+    /**
+     * The step a value between two steps is rounded to. `"halfExpand"` picks the nearer step and
+     * sends a tie to the later one; `"floor"` and `"trunc"` pick the earlier step, `"ceil"` and
+     * `"expand"` the later, and the other `"half…"` modes differ only in how a tie breaks.
+     *
+     * @defaultValue `"halfExpand"`, Temporal's default.
+     */
     roundingMode?: Temporal.RoundingMode;
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `null`. The result is in the same unit.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * The time zone the wall clock is rounded in: an IANA name, a UTC offset (a time zone
+     * identifier such as `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what
+     * `getTimeZoneOffset` returns), or `"local"` for the system time zone. An unknown zone returns
+     * `null`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
 }): number | null;

package/dist/unix/calculate/roundUnix.js

@@ -1,6 +1,5 @@
 import { isValidDateTimeUnit } from "../../plain/index.js";
-import { isObject, resolveDateTimeUnit, roundZonedDateTime, } from "../../internal/index.js";
-import { normalizeTimeZone } from "../../internal/normalizeTimeZone.js";
+import { frameInstant, frameZoned, isObject, normalizeZoneFrame, resolveDateTimeUnit, roundZonedDateTime, } from "../../internal/index.js";
 import { resolveUnixEpochUnit, toUnixEpoch, unixEpochToInstant, } from "../../internal/unixEpochValue.js";
 const ZONED_ROUNDING_UNITS = [
     "day",
@@ -28,12 +27,16 @@ function isZonedRoundingUnit(unit) {
  *   1727532300000 (03:50+13:45) truncated to the hour gives 1727532900000, 15 minutes later.
  *   Use `floorToZone` for a boundary that never exceeds the instant.
  * - `value` is a safe integer or a digit string (`"1706661000000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
  * - Returns null for invalid input.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
- * @param options Rounding options: smallestUnit, optional roundingIncrement, roundingMode, epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC")
+ * @param options rounding settings: the unit to round to, how to round, and how `value` is read
  * @returns Rounded Unix epoch number, or null on invalid input
  *
  * @example roundUnix(1706661000000, { smallestUnit: "hour", timeZone: "UTC" }) // 1706662800000 (00:30 is a tie; halfExpand rounds up)
@@ -52,11 +55,12 @@ export function roundUnix(value, options) {
             return null;
         const { roundingIncrement, roundingMode } = options;
         const epochUnit = resolveUnixEpochUnit(options.epochUnit);
-        const timeZone = normalizeTimeZone(options.timeZone);
-        const smallestUnit = typeof options.smallestUnit === "string"
-            ? resolveDateTimeUnit(options.smallestUnit)
-            : options.smallestUnit;
-        if (!timeZone || epochUnit === null || !isValidDateTimeUnit(smallestUnit)) {
+        const frame = normalizeZoneFrame(options.timeZone);
+        // One read (GetOption): resolveDateTimeUnit returns a value that is not a string unchanged.
+        const smallestUnit = resolveDateTimeUnit(options.smallestUnit);
+        if (frame === null ||
+            epochUnit === null ||
+            !isValidDateTimeUnit(smallestUnit)) {
             return null;
         }
         // Temporal ZonedDateTime.prototype.round: ValidateTemporalUnitValue(smallestUnit, ~time~, « day »)
@@ -68,12 +72,12 @@ export function roundUnix(value, options) {
             return null;
         }
         try {
-            const result = roundZonedDateTime(instant.toZonedDateTimeISO(timeZone), {
+            const result = roundZonedDateTime(frameZoned(instant, frame), {
                 smallestUnit,
                 roundingIncrement,
                 roundingMode,
             });
-            return toUnixEpoch(result, epochUnit);
+            return toUnixEpoch(frameInstant(result, frame), epochUnit);
         }
         catch {
             return null;

package/dist/unix/calculate/setUnix.d.ts

@@ -10,22 +10,32 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  *   why order-independent field resolution matters, and why `disambiguation`/`offset` require
  *   `.with()` rather than arithmetic.
  * - `fields` may set any of `year`, `month`, `monthCode`, `day`, `hour`, `minute`, `second`,
- *   `millisecond`, `microsecond`, `nanosecond`, `era`, and/or `eraYear`; omitted fields keep
- *   their current value. An empty object is a no-op.
- * - `overflow` ("constrain" (default) | "reject") controls out-of-range results, e.g. setting
- *   `month: 2` on a value whose `day` is 31: "constrain" clamps to Feb 29/28, "reject" throws
- *   (resulting in null).
+ *   `millisecond`, `microsecond` and/or `nanosecond`; omitted fields keep their current value. An
+ *   object with no field set, such as `{}` or `{ year: undefined }`, is a no-op.
+ * - Values are not converted: `monthCode` must be a string and every other field an integer number.
+ *   `null`, a numeric string, a boolean or a fraction returns null, where Temporal would convert or
+ *   truncate it. A bigint, `NaN` or an infinity returns null too. A number too large for its
+ *   field follows `overflow`. A month or day below 1, or a date outside Temporal's range, returns
+ *   null.
+ * - An own key that is not one of these fields, such as a misspelt `yaer`, returns null. So does an
+ *   era, an `offset`, or a `calendar` or `timeZone` property, whether own, inherited or a getter. A
+ *   field is read with a property get, as Temporal reads it, so an inherited or getter field is
+ *   set.
+ * - A Temporal date or time object returns null, as Temporal's `with` refuses one. One whose
+ *   prototype has been replaced with `Object.prototype`, `null` or `Function.prototype` sets
+ *   nothing instead.
  * - `value` is a safe integer or a digit string (`"1710072000000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone.
- * - `offset` defaults to `"prefer"`, as `Temporal.ZonedDateTime.prototype.with`: the source's
- *   offset is kept while it is still valid for the new wall-clock time, so a repeated hour stays on
- *   the same side of a fall-back. Pass `offset: "ignore"` to re-resolve the wall clock with
- *   `disambiguation`.
  * - Returns null for invalid input.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
  * @param fields Partial<Temporal.ZonedDateTimeLike> object (excluding calendar/timeZone/offset) specifying fields to set
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC"; an unknown zone returns null), overflow ("constrain" | "reject"), disambiguation ("compatible" | "earlier" | "later" | "reject"), offset ("prefer" | "use" | "ignore" | "reject", default "prefer")
+ * @param options optional: how `value` is read, and how an out-of-range field or a skipped or repeated wall-clock time is resolved
  * @returns Unix epoch number with fields set, or null on invalid input
  *
  * @example setUnix(1710072000000, { hour: 9 }, { timeZone: "UTC" }) // 1710061200000 (2024-03-10T09:00:00Z)
@@ -33,12 +43,48 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example setUnix(1706659200000, {}, { timeZone: "UTC" }) // 1706659200000 (empty fields object is a no-op)
  * @example setUnix(1730615400000, { minute: 45 }, { timeZone: "America/New_York" }) // 1730616300000 (the second 01:30 keeps -05:00)
  * @example setUnix(1730615400000, { minute: 45 }, { timeZone: "America/New_York", offset: "ignore" }) // 1730612700000 (re-resolved: the earlier 01:45)
+ * @example setUnix(1710072000000, { hour: "9" }, { timeZone: "UTC" }) // null (not converted)
  * @example setUnix(NaN, { hour: 9 }) // null
  */
-export declare function setUnix(value: number | string, fields: Omit<Temporal.ZonedDateTimeLike, "calendar" | "timeZone" | "offset">, options?: {
+export declare function setUnix(value: number | string, fields: Omit<Temporal.ZonedDateTimeLike, "calendar" | "timeZone" | "offset" | "era" | "eraYear">, options?: {
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `null`. The result is in the same unit.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * The time zone the fields are set in: an IANA name, a UTC offset (a time zone identifier such
+     * as `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what `getTimeZoneOffset`
+     * returns), or `"local"` for the system time zone. An unknown zone returns `null`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
+    /**
+     * How an out-of-range field is handled, such as `month: 2` on a value whose day is 31.
+     * `"constrain"` clamps to the nearest valid value, and `"reject"` returns `null`.
+     *
+     * @defaultValue `"constrain"`, Temporal's default.
+     */
     overflow?: Overflow;
+    /**
+     * How a wall-clock time that a zone transition skips or repeats is resolved, once `offset` does
+     * not settle it. `"compatible"` takes the later time in a gap and the earlier of a repeat,
+     * `"earlier"` and `"later"` take that side, and `"reject"` returns `null`.
+     *
+     * @defaultValue `"compatible"`, Temporal's default.
+     */
     disambiguation?: Disambiguation;
+    /**
+     * How the source's UTC offset is weighed against the new wall-clock time, as in
+     * `Temporal.ZonedDateTime.prototype.with`. `"prefer"` keeps it while it is still valid, so a
+     * repeated hour stays on the same side of a fall-back, and `"use"` keeps it always. `"ignore"`
+     * re-resolves the wall clock with `disambiguation`, and `"reject"` returns `null` when the
+     * offset is no longer valid.
+     *
+     * @defaultValue `"prefer"`, Temporal's default.
+     */
     offset?: Offset;
 }): number | null;

package/dist/unix/calculate/setUnix.js

@@ -1,7 +1,7 @@
-import { resolveOverflow, withZonedFields } from "../../internal/index.js";
-import { normalizeTimeZone } from "../../internal/normalizeTimeZone.js";
+import { DATE_TIME_FIELDS, frameInstant, frameZoned, normalizeZoneFrame, readSetFields, resolveOverflow, withZonedFields, } from "../../internal/index.js";
 import { resolveUnixEpochUnit, toUnixEpoch, unixEpochToInstant, } from "../../internal/unixEpochValue.js";
 import { isOptionsArgument } from "../../internal/isObject.js";
+import { optionOrDefault } from "../../internal/optionOrDefault.js";
 /**
  * Return a Unix epoch value with the given `fields` set on `value`, interpreted in `timeZone`.
  *
@@ -11,22 +11,32 @@ import { isOptionsArgument } from "../../internal/isObject.js";
  *   why order-independent field resolution matters, and why `disambiguation`/`offset` require
  *   `.with()` rather than arithmetic.
  * - `fields` may set any of `year`, `month`, `monthCode`, `day`, `hour`, `minute`, `second`,
- *   `millisecond`, `microsecond`, `nanosecond`, `era`, and/or `eraYear`; omitted fields keep
- *   their current value. An empty object is a no-op.
- * - `overflow` ("constrain" (default) | "reject") controls out-of-range results, e.g. setting
- *   `month: 2` on a value whose `day` is 31: "constrain" clamps to Feb 29/28, "reject" throws
- *   (resulting in null).
+ *   `millisecond`, `microsecond` and/or `nanosecond`; omitted fields keep their current value. An
+ *   object with no field set, such as `{}` or `{ year: undefined }`, is a no-op.
+ * - Values are not converted: `monthCode` must be a string and every other field an integer number.
+ *   `null`, a numeric string, a boolean or a fraction returns null, where Temporal would convert or
+ *   truncate it. A bigint, `NaN` or an infinity returns null too. A number too large for its
+ *   field follows `overflow`. A month or day below 1, or a date outside Temporal's range, returns
+ *   null.
+ * - An own key that is not one of these fields, such as a misspelt `yaer`, returns null. So does an
+ *   era, an `offset`, or a `calendar` or `timeZone` property, whether own, inherited or a getter. A
+ *   field is read with a property get, as Temporal reads it, so an inherited or getter field is
+ *   set.
+ * - A Temporal date or time object returns null, as Temporal's `with` refuses one. One whose
+ *   prototype has been replaced with `Object.prototype`, `null` or `Function.prototype` sets
+ *   nothing instead.
  * - `value` is a safe integer or a digit string (`"1710072000000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone.
- * - `offset` defaults to `"prefer"`, as `Temporal.ZonedDateTime.prototype.with`: the source's
- *   offset is kept while it is still valid for the new wall-clock time, so a repeated hour stays on
- *   the same side of a fall-back. Pass `offset: "ignore"` to re-resolve the wall clock with
- *   `disambiguation`.
  * - Returns null for invalid input.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
  * @param fields Partial<Temporal.ZonedDateTimeLike> object (excluding calendar/timeZone/offset) specifying fields to set
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC"; an unknown zone returns null), overflow ("constrain" | "reject"), disambiguation ("compatible" | "earlier" | "later" | "reject"), offset ("prefer" | "use" | "ignore" | "reject", default "prefer")
+ * @param options optional: how `value` is read, and how an out-of-range field or a skipped or repeated wall-clock time is resolved
  * @returns Unix epoch number with fields set, or null on invalid input
  *
  * @example setUnix(1710072000000, { hour: 9 }, { timeZone: "UTC" }) // 1710061200000 (2024-03-10T09:00:00Z)
@@ -34,6 +44,7 @@ import { isOptionsArgument } from "../../internal/isObject.js";
  * @example setUnix(1706659200000, {}, { timeZone: "UTC" }) // 1706659200000 (empty fields object is a no-op)
  * @example setUnix(1730615400000, { minute: 45 }, { timeZone: "America/New_York" }) // 1730616300000 (the second 01:30 keeps -05:00)
  * @example setUnix(1730615400000, { minute: 45 }, { timeZone: "America/New_York", offset: "ignore" }) // 1730612700000 (re-resolved: the earlier 01:45)
+ * @example setUnix(1710072000000, { hour: "9" }, { timeZone: "UTC" }) // null (not converted)
  * @example setUnix(NaN, { hour: 9 }) // null
  */
 export function setUnix(value, fields, options) {
@@ -42,30 +53,31 @@ export function setUnix(value, fields, options) {
             return null;
         }
         const epochUnit = resolveUnixEpochUnit(options?.epochUnit);
-        const timeZone = normalizeTimeZone(options?.timeZone);
-        if (!timeZone || epochUnit === null)
+        const frame = normalizeZoneFrame(options?.timeZone);
+        if (frame === null || epochUnit === null)
             return null;
         const instant = unixEpochToInstant(value, epochUnit);
         if (instant === null)
             return null;
         const overflow = resolveOverflow(options?.overflow);
-        const disambiguation = options?.disambiguation === undefined
-            ? "compatible"
-            : options.disambiguation;
+        const disambiguation = optionOrDefault(options?.disambiguation, "compatible");
         // Temporal ZonedDateTime.prototype.with: GetTemporalOffsetOption(options, "prefer").
-        const offset = options?.offset === undefined ? "prefer" : options.offset;
+        const offset = optionOrDefault(options?.offset, "prefer");
         try {
-            const zoned = instant.toZonedDateTimeISO(timeZone);
-            // Temporal.ZonedDateTime.prototype.with() throws on an empty fields object ("no supported
-            // properties found") rather than treating it as a no-op, so short-circuit here.
-            const result = Object.keys(fields).length === 0
+            const zoned = frameZoned(instant, frame);
+            const set = readSetFields(fields, DATE_TIME_FIELDS);
+            if (set === null)
+                return null;
+            // Only the values readSetFields checked reach Temporal, on both paths of withZonedFields. An
+            // empty result sets nothing: a no-op here, where Temporal's with() would throw.
+            const result = Object.keys(set).length === 0
                 ? zoned
-                : withZonedFields(zoned, fields, {
+                : withZonedFields(zoned, set, {
                     overflow,
                     disambiguation,
                     offset,
                 });
-            return toUnixEpoch(result, epochUnit);
+            return toUnixEpoch(frameInstant(result, frame), epochUnit);
         }
         catch {
             return null;

package/dist/unix/calculate/startOfQuarterForUnix.d.ts

@@ -9,11 +9,15 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  *   takes neither. Those ignored options were removed in 1.16.0.
  * - Returns null for invalid input.
  * - `value` is a safe integer or a digit string (`"1706659200000"`); anything else returns null.
- * - An omitted `timeZone` is UTC; pass `"local"` for the system time zone. An unknown zone returns
- *   null.
+ * - **Limit at an offset with seconds.** The instant is placed in the offset's whole-minute zone,
+ *   moved by its seconds, and the moved instant must be inside Temporal's range. So within the
+ *   offset's seconds (under a minute) of the last instant Temporal supports
+ *   (`+275760-09-13T00:00:00Z`) for an offset east of UTC, or of the first
+ *   (`-271821-04-20T00:00:00Z`) for one west, this returns `null`. An offset to the minute has no
+ *   such limit.
  *
  * @param value Unix epoch: a safe integer, or a string of optionally negative ASCII digits
- * @param options optional: epochUnit ("seconds" | "milliseconds", singular accepted; default "milliseconds"), timeZone (IANA, or "local" for the system zone; default "UTC")
+ * @param options optional: how `value` is read and the zone the quarter is found in
  * @returns Unix epoch number representing the start of the quarter, or null on invalid input
  *
  * @example startOfQuarterForUnix(1706659200000, { timeZone: "UTC" }) // 1704067200000
@@ -23,6 +27,20 @@ import type { UnixUnit } from "../validate/isValidUnixUnit.js";
  * @example startOfQuarterForUnix(NaN) // null
  */
 export declare function startOfQuarterForUnix(value: number | string, options?: {
+    /**
+     * The unit the epoch values are counted in: `"seconds"` or `"milliseconds"`, singular or
+     * plural. Any other value returns `null`. The result is in the same unit.
+     *
+     * @defaultValue `"milliseconds"`
+     */
     epochUnit?: UnixUnit;
+    /**
+     * The time zone the unit boundaries are found in: an IANA name, a UTC offset (a time zone
+     * identifier such as `+05:30`, `+0530` or `-08`, or a stored offset `±HH:MM[:SS]`, what
+     * `getTimeZoneOffset` returns), or `"local"` for the system time zone. An unknown zone returns
+     * `null`.
+     *
+     * @defaultValue `"UTC"`
+     */
     timeZone?: string;
 }): number | null;