date-vir 8.6.1 → 8.6.3

package/README.md

@@ -37,24 +37,24 @@ import {
     getNowFullDate,
     parseDateStringWithPattern,
     parseInputElementValue,
-    Timezone,
+    TimezoneName,
 } from 'date-vir';
 
 /**
  * Creates a FullDate from a wide range of possible inputs. See TypeScript types for full details on
  * available inputs.
  */
-createFullDate('2023-06-05', Timezone['Europe/Rome']);
+createFullDate('2023-06-05', TimezoneName['Europe/Rome']);
 
 /** Get the current date and time right now in the given timezone. */
-getNowFullDate(Timezone['America/Argentina/Buenos_Aires']);
+getNowFullDate(TimezoneName['America/Argentina/Buenos_Aires']);
 
 /**
  * Parsed the value of an <input> element directly from the element itself. This is intended to be
  * used for type="date" or type="time" <input> elements, but any input element with a valid date or
  * time string will work.
  */
-parseInputElementValue(document.querySelector('input'), Timezone['Asia/Tokyo']);
+parseInputElementValue(document.querySelector('input'), TimezoneName['Asia/Tokyo']);
 
 /**
  * If you have a really oddly formatted date/time string and createFullDate does not suffice, you
@@ -65,7 +65,7 @@ parseInputElementValue(document.querySelector('input'), Timezone['Asia/Tokyo']);
 parseDateStringWithPattern({
     dateString: '870-0-14-19 5 2023 6',
     formatString: 'S-s-h-m d yyyy M',
-    timezone: Timezone['America/Cancun'],
+    timezone: TimezoneName['America/Cancun'],
 });
 ```
 
@@ -80,14 +80,14 @@ import {
     createFullDate,
     formatPresets,
     FullDatePart,
-    Timezone,
+    TimezoneName,
     toHtmlInputString,
     toLocaleString,
     toTimestamp,
     toUtcIsoString,
 } from 'date-vir';
 
-const myFullDate = createFullDate('2023-06-05T14:19:00.870Z', Timezone['America/Chicago']);
+const myFullDate = createFullDate('2023-06-05T14:19:00.870Z', TimezoneName['America/Chicago']);
 
 /**
  * Converts the given FullDate into a UTC unix timestamp with milliseconds. Since the output is a
@@ -123,11 +123,11 @@ toHtmlInputString(myFullDate, FullDatePart.Date); // returns '2023-06-05'
 <!-- example-link: src/readme-examples/timezones.example.ts -->
 
 ```TypeScript
-import {Timezone, userTimezone, utcTimezone} from 'date-vir';
+import {TimezoneName, userTimezone, utcTimezone} from 'date-vir';
 
-Timezone['Africa/Abidjan'];
-Timezone['America/Los_Angeles'];
-Timezone['Etc/GMT+1'];
+TimezoneName['Africa/Abidjan'];
+TimezoneName['America/Los_Angeles'];
+TimezoneName['Etc/GMT+1'];
 
 utcTimezone;
 userTimezone;
@@ -142,9 +142,9 @@ The parsing and timezone conversions in `date-vir` utilize the [`luxon`](https:/
 <!-- example-link: src/readme-examples/luxon-conversion.example.ts -->
 
 ```TypeScript
-import {createFullDate, Timezone, toLuxonDateTime} from 'date-vir';
+import {createFullDate, TimezoneName, toLuxonDateTime} from 'date-vir';
 
-const myFullDate = createFullDate('2023-06-05T14:19:00.870Z', Timezone['America/Chicago']);
+const myFullDate = createFullDate('2023-06-05T14:19:00.870Z', TimezoneName['America/Chicago']);
 
 toLuxonDateTime(myFullDate);
 ```

package/dist/date-operations/calculate-relative-date.d.ts

@@ -1,5 +1,6 @@
 import { type AnyDuration } from '@date-vir/duration';
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * Calculates a new date starting at the given fullDate and adding the given offsets. Offsets can be
  * negative to go backwards in time.
@@ -13,4 +14,4 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * calculateRelativeDate(getNowInUserTimezone(), {days: 2});
  * ```
  */
-export declare function calculateRelativeDate<const SpecificTimezone extends string>(fullDate: Readonly<FullDate<SpecificTimezone>>, offset: Readonly<AnyDuration>): FullDate<SpecificTimezone>;
+export declare function calculateRelativeDate<const SpecificTimezone extends Timezone>(fullDate: Readonly<FullDate<SpecificTimezone>>, offset: Readonly<AnyDuration>): FullDate<SpecificTimezone>;

package/dist/date-operations/combine-dates.d.ts

@@ -1,11 +1,12 @@
 import { type FullDatePart } from '../full-date/full-date-parts.js';
 import { type DatePart, type FullDate, type TimePart } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * An object containing date and/or time parts or neither. Used for {@link combineDateParts}
  *
  * @category Internal
  */
-export type MaybeDateParts<SpecificTimezone extends string> = Partial<{
+export type MaybeDateParts<SpecificTimezone extends Timezone> = Partial<{
     [FullDatePart.Date]: DatePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
     [FullDatePart.Time]: TimePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
 }>;
@@ -14,8 +15,8 @@ export type MaybeDateParts<SpecificTimezone extends string> = Partial<{
  *
  * @category Internal
  */
-export type MaybeDatePart<SpecificTimezone extends string> = FullDate<SpecificTimezone> | Partial<FullDate<SpecificTimezone>> | DatePart<SpecificTimezone> | TimePart<SpecificTimezone> | undefined;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: {
+export type MaybeDatePart<SpecificTimezone extends Timezone> = FullDate<SpecificTimezone> | Partial<FullDate<SpecificTimezone>> | DatePart<SpecificTimezone> | TimePart<SpecificTimezone> | undefined;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePart.Date]: DatePart<SpecificTimezone>;
     [FullDatePart.Time]: TimePart<SpecificTimezone>;
 }): FullDate<SpecificTimezone>;
@@ -23,20 +24,20 @@ export declare function combineDateParts(maybeDateParts: {
     [FullDatePart.Date]?: undefined;
     [FullDatePart.Time]?: undefined;
 }): undefined;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: {
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePart.Date]: DatePart<SpecificTimezone>;
     [FullDatePart.Time]?: undefined;
 }): DatePart<SpecificTimezone>;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: {
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePart.Date]: DatePart<SpecificTimezone>;
     [FullDatePart.Time]?: TimePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
 }): FullDate<SpecificTimezone> | DatePart<SpecificTimezone>;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: {
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePart.Date]?: undefined;
     [FullDatePart.Time]: TimePart<SpecificTimezone>;
 }): TimePart<SpecificTimezone>;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: {
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: {
     [FullDatePart.Date]?: DatePart<SpecificTimezone> | undefined | Partial<FullDate<SpecificTimezone>>;
     [FullDatePart.Time]: TimePart<SpecificTimezone>;
 }): FullDate<SpecificTimezone> | TimePart<SpecificTimezone>;
-export declare function combineDateParts<const SpecificTimezone extends string>(maybeDateParts: MaybeDateParts<SpecificTimezone>): MaybeDatePart<SpecificTimezone>;
+export declare function combineDateParts<const SpecificTimezone extends Timezone>(maybeDateParts: MaybeDateParts<SpecificTimezone>): MaybeDatePart<SpecificTimezone>;

package/dist/date-operations/combine-dates.js

@@ -44,5 +44,7 @@ export function combineDateParts(maybeDateParts) {
     else if (datePart) {
         return datePart;
     }
-    return undefined;
+    else {
+        return undefined;
+    }
 }

package/dist/date-operations/date-position.d.ts

@@ -1,5 +1,6 @@
 import { DateUnit } from '@date-vir/duration';
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * Get the {@link DateUnit} value of a {@link FullDate}.
  *
@@ -53,7 +54,7 @@ export declare function getDateUnit(date: Readonly<FullDate>, unit: DateUnit): n
  * ); // outputs {year: 2024, month: 11, day: 1, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: utcTimezone}
  * ```
  */
-export declare function getStartDate<const SpecificTimezone extends string>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
+export declare function getStartDate<const SpecificTimezone extends Timezone>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
 /**
  * Get the end date of a specific {@link DateUnit} based on a given {@link FullDate}.
  *
@@ -80,7 +81,7 @@ export declare function getStartDate<const SpecificTimezone extends string>(date
  * ); // outputs {year: 2024, month: 11, day: 30, hour: 23, minute: 59, second: 59, millisecond: 999, timezone: utcTimezone}
  * ```
  */
-export declare function getEndDate<const SpecificTimezone extends string>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
+export declare function getEndDate<const SpecificTimezone extends Timezone>(date: Readonly<FullDate<SpecificTimezone>>, unit: DateUnit): FullDate<SpecificTimezone>;
 /**
  * Shape definition for all valid date position calculations. Used for {@link calculateDatePosition}.
  *

package/dist/date-operations/diff-dates.d.ts

@@ -13,7 +13,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * @example
  *
  * ```ts
- * import {diffDates, DurationUnit} from 'date-vir';
+ * import {diffDates, DurationUnit, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -23,7 +23,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * // get the diff in days
@@ -59,7 +59,7 @@ units: SelectedUnits, options?: Readonly<RoundOptions>): DurationBySelection<Sel
  * @example
  *
  * ```ts
- * import {isDateAfter, type FullDate} from 'date-vir';
+ * import {isDateAfter, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -69,7 +69,7 @@ units: SelectedUnits, options?: Readonly<RoundOptions>): DurationBySelection<Sel
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * isDateAfter({

package/dist/date-operations/diff-dates.js

@@ -31,7 +31,7 @@ function getHighestPriorityConversionAccuracy(units) {
  * @example
  *
  * ```ts
- * import {diffDates, DurationUnit} from 'date-vir';
+ * import {diffDates, DurationUnit, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -41,7 +41,7 @@ function getHighestPriorityConversionAccuracy(units) {
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * // get the diff in days
@@ -85,7 +85,7 @@ units, options = {}) {
  * @example
  *
  * ```ts
- * import {isDateAfter, type FullDate} from 'date-vir';
+ * import {isDateAfter, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -95,7 +95,7 @@ units, options = {}) {
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * isDateAfter({

package/dist/extra-utils/has-date-props.d.ts

@@ -1,5 +1,6 @@
 import { type PartialWithUndefined, type SetRequiredAndNotNull } from '@augment-vir/common';
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * Checks that the input has all the requested {@link FullDate} keys.
  *
@@ -13,7 +14,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * hasFullDateKeys({year: 2024}, ['day']); // `false`
  * ```
  */
-export declare function hasFullDateKeys<SpecificTimezone extends string, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, 
+export declare function hasFullDateKeys<SpecificTimezone extends Timezone, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, 
 /** A union of strings. */
 RequiredKeys extends keyof FullDate<SpecificTimezone>>(partialFullDate: PartialWithUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeys>): partialFullDate is SetRequiredAndNotNull<PartialFullDate, RequiredKeys>;
 /**
@@ -29,6 +30,6 @@ RequiredKeys extends keyof FullDate<SpecificTimezone>>(partialFullDate: PartialW
  * assertHasFullDateKeys({year: 2024}, ['day']); // fails
  * ```
  */
-export declare function assertHasFullDateKeys<SpecificTimezone extends string, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, 
+export declare function assertHasFullDateKeys<SpecificTimezone extends Timezone, PartialFullDate extends PartialWithUndefined<FullDate<SpecificTimezone>>, 
 /** A union of strings. */
 RequiredKeys extends keyof FullDate<SpecificTimezone>>(partialFullDate: PartialWithUndefined<FullDate<SpecificTimezone>>, keys: ReadonlyArray<RequiredKeys>): asserts partialFullDate is SetRequiredAndNotNull<PartialFullDate, RequiredKeys>;

package/dist/extra-utils/js-date-conversion.d.ts

@@ -7,7 +7,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * @example
  *
  * ```ts
- * import {toJsDate, type FullDate} from 'date-vir';
+ * import {toJsDate, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -17,7 +17,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * toJsDate(exampleDate);

package/dist/extra-utils/js-date-conversion.js

@@ -8,7 +8,7 @@ import { userTimezone } from '../timezone/timezones.js';
  * @example
  *
  * ```ts
- * import {toJsDate, type FullDate} from 'date-vir';
+ * import {toJsDate, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -18,7 +18,7 @@ import { userTimezone } from '../timezone/timezones.js';
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * toJsDate(exampleDate);

package/dist/extra-utils/now.d.ts

@@ -1,6 +1,6 @@
 import { type UtcIsoString } from '../formatting/string-format-types.js';
 import { type FullDate } from '../full-date/full-date-shape.js';
-import { type UtcTimezone } from '../timezone/timezones.js';
+import { type Timezone, type UtcTimezone } from '../timezone/timezones.js';
 /**
  * Get the time right now as a UTC ISO.
  *
@@ -47,10 +47,10 @@ export declare function getNowInUtcTimezone(): FullDate<UtcTimezone>;
  * @example
  *
  * ```ts
- * import {getNowFullDate, utcTimezone, timezones} from 'date-vir';
+ * import {getNowFullDate, TimezoneName, utcTimezone} from 'date-vir';
  *
  * getNowFullDate(utcTimezone);
- * getNowFullDate(timezones['Australia/Brisbane']);
+ * getNowFullDate(TimezoneName['Australia/Brisbane']);
  * ```
  */
-export declare function getNowFullDate<const SpecificTimezone extends string>(timezone: SpecificTimezone): FullDate<SpecificTimezone>;
+export declare function getNowFullDate<const SpecificTimezone extends Timezone>(timezone: SpecificTimezone): FullDate<SpecificTimezone>;

package/dist/extra-utils/now.js

@@ -57,10 +57,10 @@ export function getNowInUtcTimezone() {
  * @example
  *
  * ```ts
- * import {getNowFullDate, utcTimezone, timezones} from 'date-vir';
+ * import {getNowFullDate, TimezoneName, utcTimezone} from 'date-vir';
  *
  * getNowFullDate(utcTimezone);
- * getNowFullDate(timezones['Australia/Brisbane']);
+ * getNowFullDate(TimezoneName['Australia/Brisbane']);
  * ```
  */
 export function getNowFullDate(timezone) {

package/dist/extra-utils/override-date.d.ts

@@ -1,4 +1,5 @@
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * Override the initial provided FullDate with all subsequent FullDate parts.
  *
@@ -6,7 +7,7 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  * @example
  *
  * ```ts
- * import {overrideDateParts, type FullDate} from 'date-vir';
+ * import {overrideDateParts, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -16,11 +17,11 @@ import { type FullDate } from '../full-date/full-date-shape.js';
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * overrideDateParts(exampleDate, {day: 20}, {second: 10});
- * // `{year: 2024, month: 1, day: 20, hour: 1, minute: 1, second: 10, millisecond: 1, timezone: 'UTC'}`
+ * // `{year: 2024, month: 1, day: 20, hour: 1, minute: 1, second: 10, millisecond: 1, timezone: utcTimezone}`
  * ```
  */
-export declare function overrideDateParts<const SpecificTimezone extends string>(date: FullDate<SpecificTimezone>, ...overrides: Partial<FullDate<SpecificTimezone>>[]): FullDate<SpecificTimezone>;
+export declare function overrideDateParts<const SpecificTimezone extends Timezone>(date: FullDate<SpecificTimezone>, ...overrides: Partial<FullDate<SpecificTimezone>>[]): FullDate<SpecificTimezone>;

package/dist/extra-utils/override-date.js

@@ -5,7 +5,7 @@
  * @example
  *
  * ```ts
- * import {overrideDateParts, type FullDate} from 'date-vir';
+ * import {overrideDateParts, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -15,11 +15,11 @@
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * overrideDateParts(exampleDate, {day: 20}, {second: 10});
- * // `{year: 2024, month: 1, day: 20, hour: 1, minute: 1, second: 10, millisecond: 1, timezone: 'UTC'}`
+ * // `{year: 2024, month: 1, day: 20, hour: 1, minute: 1, second: 10, millisecond: 1, timezone: utcTimezone}`
  * ```
  */
 export function overrideDateParts(date, ...overrides) {

package/dist/extra-utils/zero.d.ts

@@ -1,5 +1,6 @@
 import { TimeKey } from '../full-date/full-date-parts.js';
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 /**
  * A {@link FullDate} instance that has the lowest, valid, non-negative, value for each property.
  *
@@ -50,7 +51,7 @@ export declare const zeroTime: Pick<{
  * @example
  *
  * ```ts
- * import {clearTime, type FullDate} from 'date-vir';
+ * import {clearTime, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -60,14 +61,14 @@ export declare const zeroTime: Pick<{
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * clearTime(exampleDate);
- * // `{year: 2024, month: 1, day: 5, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: 'UTC'}`
+ * // `{year: 2024, month: 1, day: 5, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: utcTimezone}`
  * ```
  */
-export declare function clearTime<const SpecificTimezone extends string>(inputFullDate: Readonly<FullDate<SpecificTimezone>>): FullDate<SpecificTimezone>;
+export declare function clearTime<const SpecificTimezone extends Timezone>(inputFullDate: Readonly<FullDate<SpecificTimezone>>): FullDate<SpecificTimezone>;
 /**
  * Clear all the selected parts of {@link FullDate} by setting them each to their lowest, valid
  * value. See {@link zeroDate} for the lowest valid values for each property.
@@ -76,7 +77,7 @@ export declare function clearTime<const SpecificTimezone extends string>(inputFu
  * @example
  *
  * ```ts
- * import {clearTime, type FullDate} from 'date-vir';
+ * import {clearTime, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -86,17 +87,17 @@ export declare function clearTime<const SpecificTimezone extends string>(inputFu
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * clearParts(exampleDate, [
  *     'year',
  *     'day',
  * ]);
- * // `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: 'UTC'}`
+ * // `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: utcTimezone}`
  * ```
  */
-export declare function clearParts<const SpecificTimezone extends string>(inputFullDate: Readonly<FullDate<SpecificTimezone>>, parts: ReadonlyArray<Exclude<keyof FullDate, 'timezone'>>): {
+export declare function clearParts<const SpecificTimezone extends Timezone>(inputFullDate: Readonly<FullDate<SpecificTimezone>>, parts: ReadonlyArray<Exclude<keyof FullDate, 'timezone'>>): {
     year: number;
     month: import("@date-vir/duration").MonthNumber;
     day: import("@date-vir/duration").DayOfMonth;

package/dist/extra-utils/zero.js

@@ -35,7 +35,7 @@ export const zeroTime = pickObjectKeys(zeroDate, getEnumValues(TimeKey));
  * @example
  *
  * ```ts
- * import {clearTime, type FullDate} from 'date-vir';
+ * import {clearTime, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -45,11 +45,11 @@ export const zeroTime = pickObjectKeys(zeroDate, getEnumValues(TimeKey));
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * clearTime(exampleDate);
- * // `{year: 2024, month: 1, day: 5, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: 'UTC'}`
+ * // `{year: 2024, month: 1, day: 5, hour: 0, minute: 0, second: 0, millisecond: 0, timezone: utcTimezone}`
  * ```
  */
 export function clearTime(inputFullDate) {
@@ -63,7 +63,7 @@ export function clearTime(inputFullDate) {
  * @example
  *
  * ```ts
- * import {clearTime, type FullDate} from 'date-vir';
+ * import {clearTime, type FullDate, utcTimezone} from 'date-vir';
  *
  * const exampleDate: Readonly<FullDate> = {
  *     year: 2024,
@@ -73,14 +73,14 @@ export function clearTime(inputFullDate) {
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * clearParts(exampleDate, [
  *     'year',
  *     'day',
  * ]);
- * // `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: 'UTC'}`
+ * // `{year: 0, month: 1, day: 1, hour: 1, minute: 1, second: 1, millisecond: 1, timezone: utcTimezone}`
  * ```
  */
 export function clearParts(inputFullDate, parts) {

package/dist/formatting/formatted-string.js

@@ -1,3 +1,4 @@
+/* eslint-disable @virmator/prefer-params-object */
 import { userLocale } from '@date-vir/duration';
 import { toLuxonDateTime } from '../full-date/luxon-date-time-conversion.js';
 /**

package/dist/formatting/relative-string.js

@@ -206,5 +206,7 @@ function determineShouldUseJustNow({ options, smallestSelectedUnit, unitCounts,
         /* node:coverage enable */
         return unitValue <= unitThreshold;
     }
-    return false;
+    else {
+        return false;
+    }
 }

package/dist/formatting/simple-strings.d.ts

@@ -1,5 +1,6 @@
 import { type SetOptionalAndNullable } from '@augment-vir/common';
 import { type FullDate } from '../full-date/full-date-shape.js';
+import { type Timezone } from '../timezone/timezones.js';
 import { type JustDateString, type JustTimeString, type JustTimeWithSecondsString } from './string-format-types.js';
 /**
  * Create a string based on just the date parts of a FullDate.
@@ -57,7 +58,7 @@ export type FullDateForParts = SetOptionalAndNullable<FullDate, 'millisecond'>;
  * result = {
  *     date: '2024-04-24',
  *     time: '06:04:09',
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  * ```
  */
@@ -66,7 +67,7 @@ export declare function toDatePartStrings(fullDate: FullDateForParts, options: {
 }): {
     date: JustDateString;
     time: JustTimeWithSecondsString;
-    timezone: string;
+    timezone: Timezone;
 };
 /**
  * Splits a FullDate up into multiple formatted string representations.
@@ -98,7 +99,7 @@ export declare function toDatePartStrings(fullDate: FullDateForParts, options: {
  * result = {
  *     date: '2024-04-24',
  *     time: '06:04:09',
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  * ```
  */
@@ -107,7 +108,7 @@ export declare function toDatePartStrings(fullDate: SetOptionalAndNullable<FullD
 }): {
     date: JustDateString;
     time: JustTimeString;
-    timezone: string;
+    timezone: Timezone;
 };
 /**
  * Splits a FullDate up into multiple formatted string representations.
@@ -139,7 +140,7 @@ export declare function toDatePartStrings(fullDate: SetOptionalAndNullable<FullD
  * result = {
  *     date: '2024-04-24',
  *     time: '06:04:09',
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  * ```
  */
@@ -148,7 +149,7 @@ export declare function toDatePartStrings(fullDate: FullDateForParts, options: {
 }): {
     date: JustDateString;
     time: JustTimeWithSecondsString | JustTimeString;
-    timezone: string;
+    timezone: Timezone;
 };
 /**
  * Converts a date into a simple, unambiguous date string.

package/dist/formatting/simple-strings.js

@@ -67,7 +67,7 @@ export function toSimpleTimePartString(fullDate, includeSeconds) {
  * result = {
  *     date: '2024-04-24',
  *     time: '06:04:09',
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  * ```
  */

package/dist/formatting/timestamp.d.ts

@@ -8,7 +8,7 @@ import { type HttpDateString, type UtcIsoString } from './string-format-types.js
  * @example
  *
  * ```ts
- * import {toTimestamp} from 'date-vir';
+ * import {toTimestamp, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -18,7 +18,7 @@ import { type HttpDateString, type UtcIsoString } from './string-format-types.js
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * toTimestamp(exampleDate); // `1704416461001`
@@ -37,7 +37,7 @@ export declare function toTimestamp(fullDate: FullDate): number;
  * @example
  *
  * ```ts
- * import {toUtcIsoString} from 'date-vir';
+ * import {toUtcIsoString, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -47,7 +47,7 @@ export declare function toTimestamp(fullDate: FullDate): number;
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * toUtcIsoString(exampleDate); // `'2024-01-05T01:01:01.001Z'`
@@ -93,7 +93,7 @@ dateLike: Readonly<DateLike>): UtcIsoString;
  * @example
  *
  * ```ts
- * import {toHttpDateString} from 'date-vir';
+ * import {toHttpDateString, utcTimezone} from 'date-vir';
  *
  * const exampleDate: FullDate = {
  *     year: 2024,
@@ -103,7 +103,7 @@ dateLike: Readonly<DateLike>): UtcIsoString;
  *     minute: 1,
  *     second: 1,
  *     millisecond: 1,
- *     timezone: 'UTC',
+ *     timezone: utcTimezone,
  * };
  *
  * toHttpDateString(exampleDate); // `'Fri, 05 Jan 2024 01:01:01 GMT'`