effect 4.0.0-beta.69 → 4.0.0-beta.70

package/dist/DateTime.d.ts

@@ -75,6 +75,8 @@ export type DateTime = Utc | Zoned;
  * Represents a `DateTime` stored as an absolute UTC instant with no associated
  * time zone.
  *
+ * **Details**
+ *
  * Use `DateTime.isUtc` to narrow a `DateTime` to this variant.
  *
  * @category models
@@ -88,6 +90,8 @@ export interface Utc extends DateTime.Proto {
 /**
  * Represents a `DateTime` with an associated `TimeZone`.
  *
+ * **Details**
+ *
  * A zoned value still represents an absolute instant through
  * `epochMilliseconds`, while the time zone is used for wall-clock parts,
  * formatting, and zone-aware transformations.
@@ -114,6 +118,8 @@ export declare namespace DateTime {
      * Input accepted by `DateTime.make`, `DateTime.makeUnsafe`, and the zoned
      * constructors.
      *
+     * **Details**
+     *
      * Includes existing `DateTime` values, partial date parts, epoch-millisecond
      * objects, epoch milliseconds, JavaScript `Date` instances, and parseable date
      * strings.
@@ -125,6 +131,8 @@ export declare namespace DateTime {
     /**
      * Type-level helper used by constructors to preserve a zoned input.
      *
+     * **Details**
+     *
      * When the input type is `DateTime.Zoned`, the result type is
      * `DateTime.Zoned`; otherwise the result type is `DateTime.Utc`.
      *
@@ -136,6 +144,8 @@ export declare namespace DateTime {
      * Date and time unit name accepted by `DateTime` rounding and arithmetic
      * APIs.
      *
+     * **Details**
+     *
      * Includes both singular units, such as `"day"`, and plural units, such as
      * `"days"`.
      *
@@ -162,6 +172,8 @@ export declare namespace DateTime {
     /**
      * Calendar and time components of a `DateTime`, including the weekday.
      *
+     * **Details**
+     *
      * `month` is one-based (`1` for January through `12` for December), and
      * `weekDay` follows JavaScript `Date#getUTCDay` numbering (`0` for Sunday
      * through `6` for Saturday).
@@ -182,6 +194,8 @@ export declare namespace DateTime {
     /**
      * Calendar and time components of a `DateTime`, without weekday information.
      *
+     * **Details**
+     *
      * `month` is one-based (`1` for January through `12` for December).
      *
      * @category models
@@ -199,6 +213,8 @@ export declare namespace DateTime {
     /**
      * Plural amount fields accepted by `DateTime.add` and `DateTime.subtract`.
      *
+     * **Details**
+     *
      * Each field represents the number of units to add or subtract for that part.
      *
      * @category models
@@ -227,6 +243,8 @@ export declare namespace DateTime {
     /**
      * Object input representing an absolute instant plus a time zone identifier.
      *
+     * **Details**
+     *
      * `DateTime.makeZoned` and `DateTime.makeZonedUnsafe` use `timeZoneId` when
      * no explicit `timeZone` option is supplied.
      *
@@ -240,6 +258,8 @@ export declare namespace DateTime {
     /**
      * Shared protocol implemented by all `DateTime` values.
      *
+     * **Details**
+     *
      * Provides the `DateTime` type identifier along with pipe and inspection
      * support.
      *
@@ -253,6 +273,8 @@ export declare namespace DateTime {
 /**
  * Represents a time zone used by `DateTime.Zoned`.
  *
+ * **Details**
+ *
  * A `TimeZone` is either a fixed offset from UTC or a named IANA time zone.
  *
  * @category models
@@ -269,6 +291,8 @@ export declare namespace TimeZone {
     /**
      * Shared protocol implemented by all `TimeZone` values.
      *
+     * **Details**
+     *
      * Provides the `TimeZone` type identifier and inspection support.
      *
      * @category models
@@ -280,6 +304,8 @@ export declare namespace TimeZone {
     /**
      * Fixed-offset time zone.
      *
+     * **Details**
+     *
      * The `offset` is measured in milliseconds from UTC. Positive offsets are
      * ahead of UTC, and negative offsets are behind UTC.
      *
@@ -293,6 +319,8 @@ export declare namespace TimeZone {
     /**
      * Named IANA time zone.
      *
+     * **Details**
+     *
      * The `id` field contains the resolved time zone identifier, such as
      * `"Europe/London"` or `"America/New_York"`.
      *
@@ -308,6 +336,8 @@ export declare namespace TimeZone {
  * A `Disambiguation` is used to resolve ambiguities when a `DateTime` is
  * ambiguous, such as during a daylight saving time transition.
  *
+ * **Details**
+ *
  * For more information, see the [Temporal documentation](https://tc39.es/proposal-temporal/docs/timezone.html#ambiguity-due-to-dst-or-other-time-zone-offset-changes)
  *
  * - `"compatible"`: (default) Behavior matching Temporal API and legacy JavaScript Date and moment.js.
@@ -411,6 +441,8 @@ export declare const isZoned: (self: DateTime) => self is Zoned;
 /**
  * An `Equivalence` for comparing two `DateTime` values for equality.
  *
+ * **Details**
+ *
  * Two `DateTime` values are considered equivalent if they represent the same
  * point in time, regardless of their time zone.
  *
@@ -434,6 +466,8 @@ export declare const Equivalence: Equ.Equivalence<DateTime>;
 /**
  * An `Order` for comparing and sorting `DateTime` values.
  *
+ * **Details**
+ *
  * `DateTime` values are ordered by their epoch milliseconds, so earlier times
  * come before later times regardless of time zone.
  *
@@ -459,6 +493,8 @@ export declare const Order: order.Order<DateTime>;
 /**
  * Clamp a `DateTime` between a minimum and maximum value.
  *
+ * **Details**
+ *
  * If the `DateTime` is before the minimum, the minimum is returned.
  * If the `DateTime` is after the maximum, the maximum is returned.
  * Otherwise, the original `DateTime` is returned.
@@ -483,6 +519,8 @@ export declare const clamp: {
     /**
      * Clamp a `DateTime` between a minimum and maximum value.
      *
+     * **Details**
+     *
      * If the `DateTime` is before the minimum, the minimum is returned.
      * If the `DateTime` is after the maximum, the maximum is returned.
      * Otherwise, the original `DateTime` is returned.
@@ -510,6 +548,8 @@ export declare const clamp: {
     /**
      * Clamp a `DateTime` between a minimum and maximum value.
      *
+     * **Details**
+     *
      * If the `DateTime` is before the minimum, the minimum is returned.
      * If the `DateTime` is after the maximum, the maximum is returned.
      * Otherwise, the original `DateTime` is returned.
@@ -538,6 +578,8 @@ export declare const clamp: {
 /**
  * Create a `DateTime` from a `Date`.
  *
+ * **Details**
+ *
  * If the `Date` is invalid, an `IllegalArgumentError` will be thrown.
  *
  * **Example** (Creating DateTime values from Dates)
@@ -556,7 +598,9 @@ export declare const clamp: {
  */
 export declare const fromDateUnsafe: (date: Date) => Utc;
 /**
- * Create a `DateTime` from one of the following:
+ * Create a `DateTime` from supported input values.
+ *
+ * **Details**
  *
  * - A `DateTime`
  * - A `Date` instance (invalid dates will throw an `IllegalArgumentError`)
@@ -589,6 +633,8 @@ export declare const makeUnsafe: <A extends DateTime.Input>(input: A) => DateTim
 /**
  * Create a `DateTime.Zoned` using `DateTime.makeUnsafe` and a time zone.
  *
+ * **Details**
+ *
  * The input is treated as UTC and then the time zone is attached, unless
  * `adjustForTimeZone` is set to `true`. In that case, the input is treated as
  * already in the time zone.
@@ -623,6 +669,8 @@ export declare const makeZonedUnsafe: (input: DateTime.Input, options?: {
 /**
  * Creates a `DateTime.Zoned` from an input and a time zone.
  *
+ * **Details**
+ *
  * By default, the input is interpreted as a UTC instant and the time zone is
  * attached without changing that instant. When `adjustForTimeZone` is `true`,
  * the input is interpreted as wall-clock time in the target zone.
@@ -663,7 +711,9 @@ export declare const makeZoned: (input: DateTime.Input, options?: {
     readonly disambiguation?: Disambiguation | undefined;
 }) => Option.Option<Zoned>;
 /**
- * Creates a `DateTime` from one of the following:
+ * Creates a `DateTime` from supported input values.
+ *
+ * **Details**
  *
  * - A `DateTime`
  * - A JavaScript `Date`
@@ -703,6 +753,8 @@ export declare const make: <A extends DateTime.Input>(input: A) => Option.Option
 /**
  * Parses an ISO zoned date-time string into a `DateTime.Zoned`.
  *
+ * **Details**
+ *
  * Accepts named-zone strings such as
  * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]` and offset-only strings such as
  * `YYYY-MM-DDTHH:mm:ss.sss+HH:MM`. Returns `None` when the input cannot be
@@ -768,6 +820,8 @@ export declare const nowAsDate: Effect.Effect<Date>;
 /**
  * Get the current time using `Date.now`.
  *
+ * **Details**
+ *
  * This is a synchronous version of `now` that directly uses `Date.now()`
  * instead of the Effect `Clock` service.
  *
@@ -877,6 +931,8 @@ export declare const setZone: {
 /**
  * Add a fixed offset time zone to a `DateTime`.
  *
+ * **Details**
+ *
  * The offset is in milliseconds.
  *
  * **Example** (Setting fixed-offset time zones)
@@ -899,6 +955,8 @@ export declare const setZoneOffset: {
     /**
      * Add a fixed offset time zone to a `DateTime`.
      *
+     * **Details**
+     *
      * The offset is in milliseconds.
      *
      * **Example** (Setting fixed-offset time zones)
@@ -924,6 +982,8 @@ export declare const setZoneOffset: {
     /**
      * Add a fixed offset time zone to a `DateTime`.
      *
+     * **Details**
+     *
      * The offset is in milliseconds.
      *
      * **Example** (Setting fixed-offset time zones)
@@ -950,6 +1010,8 @@ export declare const setZoneOffset: {
 /**
  * Attempt to create a named time zone from a IANA time zone identifier.
  *
+ * **Details**
+ *
  * If the time zone is invalid, an `IllegalArgumentError` will be thrown.
  *
  * **Example** (Creating named time zones unsafely)
@@ -974,6 +1036,8 @@ export declare const zoneMakeNamedUnsafe: (zoneId: string) => TimeZone.Named;
 /**
  * Create a fixed offset time zone.
  *
+ * **Details**
+ *
  * The offset is specified in milliseconds from UTC. Positive values are
  * ahead of UTC, negative values are behind UTC.
  *
@@ -997,6 +1061,8 @@ export declare const zoneMakeOffset: (offset: number) => TimeZone.Offset;
 /**
  * Create a named time zone from a IANA time zone identifier.
  *
+ * **Details**
+ *
  * If the time zone is invalid, `None` will be returned.
  *
  * **Example** (Creating optional named time zones)
@@ -1018,6 +1084,8 @@ export declare const zoneMakeNamed: (zoneId: string) => Option.Option<TimeZone.N
 /**
  * Create a named time zone from a IANA time zone identifier.
  *
+ * **Details**
+ *
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
  *
  * **Example** (Creating named time zones effectfully)
@@ -1039,6 +1107,8 @@ export declare const zoneMakeNamedEffect: (zoneId: string) => Effect.Effect<Time
 /**
  * Create a named time zone from the system's local time zone.
  *
+ * **Details**
+ *
  * This uses the system's configured time zone, which may vary depending
  * on the runtime environment.
  *
@@ -1058,6 +1128,8 @@ export declare const zoneMakeLocal: () => TimeZone.Named;
 /**
  * Try to parse a `TimeZone` from a string.
  *
+ * **Details**
+ *
  * Supports both IANA time zone identifiers and offset formats like "+03:00".
  *
  * **Example** (Parsing time zones)
@@ -1235,6 +1307,8 @@ export declare const setZoneNamedUnsafe: {
  * Calulate the difference between two `DateTime` values, returning a
  * `Duration` representing the amount of time between them.
  *
+ * **Details**
+ *
  * If `other` is *after* `self`, the result will be a positive `Duration`. If
  * `other` is *before* `self`, the result will be a negative `Duration`. If they
  * are equal, the result will be a `Duration` of zero.
@@ -1261,6 +1335,8 @@ export declare const distance: {
      * Calulate the difference between two `DateTime` values, returning a
      * `Duration` representing the amount of time between them.
      *
+     * **Details**
+     *
      * If `other` is *after* `self`, the result will be a positive `Duration`. If
      * `other` is *before* `self`, the result will be a negative `Duration`. If they
      * are equal, the result will be a `Duration` of zero.
@@ -1287,6 +1363,8 @@ export declare const distance: {
      * Calulate the difference between two `DateTime` values, returning a
      * `Duration` representing the amount of time between them.
      *
+     * **Details**
+     *
      * If `other` is *after* `self`, the result will be a positive `Duration`. If
      * `other` is *before* `self`, the result will be a negative `Duration`. If they
      * are equal, the result will be a `Duration` of zero.
@@ -1737,6 +1815,8 @@ export declare const between: {
 /**
  * Checks if a `DateTime` is in the future compared to the current time.
  *
+ * **Details**
+ *
  * This is an effectful operation that uses the current time from the `Clock` service.
  *
  * **Example** (Checking future DateTime values effectfully)
@@ -1758,6 +1838,8 @@ export declare const isFuture: (self: DateTime) => Effect.Effect<boolean>;
 /**
  * Checks if a `DateTime` is in the future compared to the current time.
  *
+ * **Details**
+ *
  * This is a synchronous version that uses `Date.now()` directly.
  *
  * **Example** (Checking future DateTime values unsafely)
@@ -1779,6 +1861,8 @@ export declare const isFutureUnsafe: (self: DateTime) => boolean;
 /**
  * Checks if a `DateTime` is in the past compared to the current time.
  *
+ * **Details**
+ *
  * This is an effectful operation that uses the current time from the `Clock` service.
  *
  * **Example** (Checking past DateTime values effectfully)
@@ -1800,6 +1884,8 @@ export declare const isPast: (self: DateTime) => Effect.Effect<boolean>;
 /**
  * Checks if a `DateTime` is in the past compared to the current time.
  *
+ * **Details**
+ *
  * This is a synchronous version that uses `Date.now()` directly.
  *
  * **Example** (Checking past DateTime values unsafely)
@@ -1821,6 +1907,8 @@ export declare const isPastUnsafe: (self: DateTime) => boolean;
 /**
  * Get the UTC `Date` of a `DateTime`.
  *
+ * **Details**
+ *
  * This always returns the UTC representation, ignoring any time zone information.
  *
  * **Example** (Converting DateTime values to UTC Dates)
@@ -1843,6 +1931,8 @@ export declare const toDateUtc: (self: DateTime) => Date;
 /**
  * Convert a `DateTime` to a `Date`, applying the time zone first.
  *
+ * **Details**
+ *
  * For `DateTime.Zoned`, this adjusts for the time zone before converting.
  * For `DateTime.Utc`, this is equivalent to `toDateUtc`.
  *
@@ -1867,6 +1957,8 @@ export declare const toDate: (self: DateTime) => Date;
 /**
  * Calculate the time zone offset of a `DateTime.Zoned` in milliseconds.
  *
+ * **Details**
+ *
  * Returns the offset from UTC in milliseconds. Positive values indicate
  * time zones ahead of UTC, negative values indicate time zones behind UTC.
  *
@@ -1890,6 +1982,8 @@ export declare const zonedOffset: (self: Zoned) => number;
 /**
  * Format the time zone offset of a `DateTime.Zoned` as an ISO string.
  *
+ * **Details**
+ *
  * The offset is formatted as "±HH:MM".
  *
  * **Example** (Formatting zoned offsets)
@@ -1912,6 +2006,8 @@ export declare const zonedOffsetIso: (self: Zoned) => string;
 /**
  * Get the milliseconds since the Unix epoch of a `DateTime`.
  *
+ * **Details**
+ *
  * This returns the UTC timestamp regardless of any time zone information.
  *
  * **Example** (Reading epoch milliseconds)
@@ -1955,6 +2051,8 @@ export declare const removeTime: (self: DateTime) => Utc;
 /**
  * Get the different parts of a `DateTime` as an object.
  *
+ * **Details**
+ *
  * The parts will be time zone adjusted if the `DateTime` is zoned.
  *
  * **Example** (Reading DateTime parts)
@@ -1985,6 +2083,8 @@ export declare const toParts: (self: DateTime) => DateTime.PartsWithWeekday;
 /**
  * Get the different parts of a `DateTime` as an object.
  *
+ * **Details**
+ *
  * The parts will always be in UTC, ignoring any time zone information.
  *
  * **Example** (Reading UTC DateTime parts)
@@ -2008,6 +2108,8 @@ export declare const toPartsUtc: (self: DateTime) => DateTime.PartsWithWeekday;
 /**
  * Get a part of a `DateTime` as a number.
  *
+ * **Details**
+ *
  * The part will be in the UTC time zone.
  *
  * **Example** (Reading UTC DateTime parts by key)
@@ -2027,6 +2129,8 @@ export declare const getPartUtc: {
     /**
      * Get a part of a `DateTime` as a number.
      *
+     * **Details**
+     *
      * The part will be in the UTC time zone.
      *
      * **Example** (Reading UTC DateTime parts by key)
@@ -2046,6 +2150,8 @@ export declare const getPartUtc: {
     /**
      * Get a part of a `DateTime` as a number.
      *
+     * **Details**
+     *
      * The part will be in the UTC time zone.
      *
      * **Example** (Reading UTC DateTime parts by key)
@@ -2066,6 +2172,8 @@ export declare const getPartUtc: {
 /**
  * Get a part of a `DateTime` as a number.
  *
+ * **Details**
+ *
  * The part will be time zone adjusted.
  *
  * **Example** (Reading DateTime parts by key)
@@ -2087,6 +2195,8 @@ export declare const getPart: {
     /**
      * Get a part of a `DateTime` as a number.
      *
+     * **Details**
+     *
      * The part will be time zone adjusted.
      *
      * **Example** (Reading DateTime parts by key)
@@ -2108,6 +2218,8 @@ export declare const getPart: {
     /**
      * Get a part of a `DateTime` as a number.
      *
+     * **Details**
+     *
      * The part will be time zone adjusted.
      *
      * **Example** (Reading DateTime parts by key)
@@ -2130,6 +2242,8 @@ export declare const getPart: {
 /**
  * Set the different parts of a `DateTime` as an object.
  *
+ * **Details**
+ *
  * The date will be time zone adjusted for `DateTime.Zoned`.
  *
  * **Example** (Updating DateTime parts)
@@ -2154,6 +2268,8 @@ export declare const setParts: {
     /**
      * Set the different parts of a `DateTime` as an object.
      *
+     * **Details**
+     *
      * The date will be time zone adjusted for `DateTime.Zoned`.
      *
      * **Example** (Updating DateTime parts)
@@ -2178,6 +2294,8 @@ export declare const setParts: {
     /**
      * Set the different parts of a `DateTime` as an object.
      *
+     * **Details**
+     *
      * The date will be time zone adjusted for `DateTime.Zoned`.
      *
      * **Example** (Updating DateTime parts)
@@ -2203,6 +2321,8 @@ export declare const setParts: {
 /**
  * Set the different parts of a `DateTime` as an object.
  *
+ * **Details**
+ *
  * The parts are always interpreted as UTC, ignoring any time zone information.
  *
  * **Example** (Updating UTC DateTime parts)
@@ -2226,6 +2346,8 @@ export declare const setPartsUtc: {
     /**
      * Set the different parts of a `DateTime` as an object.
      *
+     * **Details**
+     *
      * The parts are always interpreted as UTC, ignoring any time zone information.
      *
      * **Example** (Updating UTC DateTime parts)
@@ -2249,6 +2371,8 @@ export declare const setPartsUtc: {
     /**
      * Set the different parts of a `DateTime` as an object.
      *
+     * **Details**
+     *
      * The parts are always interpreted as UTC, ignoring any time zone information.
      *
      * **Example** (Updating UTC DateTime parts)
@@ -2276,6 +2400,8 @@ declare const CurrentTimeZone_base: Context.ServiceClass<CurrentTimeZone, "effec
  * the current zone, such as `DateTime.setZoneCurrent` and
  * `DateTime.nowInCurrentZone`.
  *
+ * **Details**
+ *
  * Provide it with `DateTime.withCurrentZone`, one of the `withCurrentZone*`
  * helpers, or one of the `layerCurrentZone*` layers.
  *
@@ -2457,6 +2583,8 @@ export declare const withCurrentZoneOffset: {
  * Provide the `CurrentTimeZone` to an effect using an IANA time zone
  * identifier.
  *
+ * **Details**
+ *
  * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
  *
  * **Example** (Providing a named time zone)
@@ -2478,6 +2606,8 @@ export declare const withCurrentZoneNamed: {
      * Provide the `CurrentTimeZone` to an effect using an IANA time zone
      * identifier.
      *
+     * **Details**
+     *
      * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
      *
      * **Example** (Providing a named time zone)
@@ -2499,6 +2629,8 @@ export declare const withCurrentZoneNamed: {
      * Provide the `CurrentTimeZone` to an effect using an IANA time zone
      * identifier.
      *
+     * **Details**
+     *
      * If the time zone is invalid, it will fail with an `IllegalArgumentError`.
      *
      * **Example** (Providing a named time zone)
@@ -2538,6 +2670,8 @@ export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZo
 /**
  * Modify a `DateTime` by applying a function to a cloned `Date` instance.
  *
+ * **Details**
+ *
  * The `Date` will first have the time zone applied if possible, and then be
  * converted back to a `DateTime` within the same time zone.
  *
@@ -2565,6 +2699,8 @@ export declare const mutate: {
     /**
      * Modify a `DateTime` by applying a function to a cloned `Date` instance.
      *
+     * **Details**
+     *
      * The `Date` will first have the time zone applied if possible, and then be
      * converted back to a `DateTime` within the same time zone.
      *
@@ -2594,6 +2730,8 @@ export declare const mutate: {
     /**
      * Modify a `DateTime` by applying a function to a cloned `Date` instance.
      *
+     * **Details**
+     *
      * The `Date` will first have the time zone applied if possible, and then be
      * converted back to a `DateTime` within the same time zone.
      *
@@ -2750,11 +2888,14 @@ export declare const mapEpochMillis: {
     <A extends DateTime>(self: A, f: (millis: number) => number): A;
 };
 /**
- * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
- * instant and returns the function's result.
+ * Applies a function to a JavaScript `Date` representing the `DateTime` and
+ * returns the function's result.
  *
- * This ignores any associated time zone. Use `DateTime.withDate` when the
- * callback should receive the time-zone-adjusted wall-clock date.
+ * **Details**
+ *
+ * The callback receives the time-zone-adjusted wall-clock date for
+ * `DateTime.Zoned` values. Use `DateTime.withDateUtc` when the callback should
+ * receive the UTC instant.
  *
  * **Example** (Using time zone adjusted Dates)
  *
@@ -2772,11 +2913,14 @@ export declare const mapEpochMillis: {
  */
 export declare const withDate: {
     /**
-     * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
-     * instant and returns the function's result.
+     * Applies a function to a JavaScript `Date` representing the `DateTime` and
+     * returns the function's result.
      *
-     * This ignores any associated time zone. Use `DateTime.withDate` when the
-     * callback should receive the time-zone-adjusted wall-clock date.
+     * **Details**
+     *
+     * The callback receives the time-zone-adjusted wall-clock date for
+     * `DateTime.Zoned` values. Use `DateTime.withDateUtc` when the callback should
+     * receive the UTC instant.
      *
      * **Example** (Using time zone adjusted Dates)
      *
@@ -2794,11 +2938,14 @@ export declare const withDate: {
      */
     <A>(f: (date: Date) => A): (self: DateTime) => A;
     /**
-     * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
-     * instant and returns the function's result.
+     * Applies a function to a JavaScript `Date` representing the `DateTime` and
+     * returns the function's result.
      *
-     * This ignores any associated time zone. Use `DateTime.withDate` when the
-     * callback should receive the time-zone-adjusted wall-clock date.
+     * **Details**
+     *
+     * The callback receives the time-zone-adjusted wall-clock date for
+     * `DateTime.Zoned` values. Use `DateTime.withDateUtc` when the callback should
+     * receive the UTC instant.
      *
      * **Example** (Using time zone adjusted Dates)
      *
@@ -2820,6 +2967,8 @@ export declare const withDate: {
  * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
  * instant and returns the function's result.
  *
+ * **Details**
+ *
  * This ignores any associated time zone. Use `DateTime.withDate` when the
  * callback should receive the time-zone-adjusted wall-clock date.
  *
@@ -2842,6 +2991,8 @@ export declare const withDateUtc: {
      * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
      * instant and returns the function's result.
      *
+     * **Details**
+     *
      * This ignores any associated time zone. Use `DateTime.withDate` when the
      * callback should receive the time-zone-adjusted wall-clock date.
      *
@@ -2864,6 +3015,8 @@ export declare const withDateUtc: {
      * Applies a function to a JavaScript `Date` representing the `DateTime`'s UTC
      * instant and returns the function's result.
      *
+     * **Details**
+     *
      * This ignores any associated time zone. Use `DateTime.withDate` when the
      * callback should receive the time-zone-adjusted wall-clock date.
      *
@@ -3096,6 +3249,8 @@ export declare const subtractDuration: {
 /**
  * Add the given `amount` of `unit`'s to a `DateTime`.
  *
+ * **Details**
+ *
  * The time zone is taken into account when adding days, weeks, months, and
  * years.
  *
@@ -3117,6 +3272,8 @@ export declare const add: {
     /**
      * Add the given `amount` of `unit`'s to a `DateTime`.
      *
+     * **Details**
+     *
      * The time zone is taken into account when adding days, weeks, months, and
      * years.
      *
@@ -3138,6 +3295,8 @@ export declare const add: {
     /**
      * Add the given `amount` of `unit`'s to a `DateTime`.
      *
+     * **Details**
+     *
      * The time zone is taken into account when adding days, weeks, months, and
      * years.
      *
@@ -3215,6 +3374,8 @@ export declare const subtract: {
 /**
  * Converts a `DateTime` to the start of the given `part`.
  *
+ * **Details**
+ *
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
  * day of the week that the week starts on. The default is 0 (Sunday).
  *
@@ -3237,6 +3398,8 @@ export declare const startOf: {
     /**
      * Converts a `DateTime` to the start of the given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3261,6 +3424,8 @@ export declare const startOf: {
     /**
      * Converts a `DateTime` to the start of the given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3286,6 +3451,8 @@ export declare const startOf: {
 /**
  * Converts a `DateTime` to the end of the given `part`.
  *
+ * **Details**
+ *
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
  * day of the week that the week starts on. The default is 0 (Sunday).
  *
@@ -3308,6 +3475,8 @@ export declare const endOf: {
     /**
      * Converts a `DateTime` to the end of the given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3332,6 +3501,8 @@ export declare const endOf: {
     /**
      * Converts a `DateTime` to the end of the given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3357,6 +3528,8 @@ export declare const endOf: {
 /**
  * Converts a `DateTime` to the nearest given `part`.
  *
+ * **Details**
+ *
  * If the part is `week`, the `weekStartsOn` option can be used to specify the
  * day of the week that the week starts on. The default is 0 (Sunday).
  *
@@ -3379,6 +3552,8 @@ export declare const nearest: {
     /**
      * Converts a `DateTime` to the nearest given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3403,6 +3578,8 @@ export declare const nearest: {
     /**
      * Converts a `DateTime` to the nearest given `part`.
      *
+     * **Details**
+     *
      * If the part is `week`, the `weekStartsOn` option can be used to specify the
      * day of the week that the week starts on. The default is 0 (Sunday).
      *
@@ -3428,6 +3605,8 @@ export declare const nearest: {
 /**
  * Formats a `DateTime` with `Intl.DateTimeFormat`.
  *
+ * **Details**
+ *
  * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
  * zoned values are formatted in their named zone or fixed-offset zone.
  *
@@ -3460,6 +3639,8 @@ export declare const format: {
     /**
      * Formats a `DateTime` with `Intl.DateTimeFormat`.
      *
+     * **Details**
+     *
      * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
      * zoned values are formatted in their named zone or fixed-offset zone.
      *
@@ -3494,6 +3675,8 @@ export declare const format: {
     /**
      * Formats a `DateTime` with `Intl.DateTimeFormat`.
      *
+     * **Details**
+     *
      * Unless a `timeZone` option is supplied, UTC values are formatted in UTC and
      * zoned values are formatted in their named zone or fixed-offset zone.
      *
@@ -3529,6 +3712,8 @@ export declare const format: {
 /**
  * Format a `DateTime` as a string using the `DateTimeFormat` API.
  *
+ * **Details**
+ *
  * It will use the system's local time zone & locale.
  *
  * **Example** (Formatting DateTime values locally)
@@ -3557,6 +3742,8 @@ export declare const formatLocal: {
     /**
      * Format a `DateTime` as a string using the `DateTimeFormat` API.
      *
+     * **Details**
+     *
      * It will use the system's local time zone & locale.
      *
      * **Example** (Formatting DateTime values locally)
@@ -3587,6 +3774,8 @@ export declare const formatLocal: {
     /**
      * Format a `DateTime` as a string using the `DateTimeFormat` API.
      *
+     * **Details**
+     *
      * It will use the system's local time zone & locale.
      *
      * **Example** (Formatting DateTime values locally)
@@ -3618,6 +3807,8 @@ export declare const formatLocal: {
 /**
  * Format a `DateTime` as a string using the `DateTimeFormat` API.
  *
+ * **Details**
+ *
  * This forces the time zone to be UTC.
  *
  * **Example** (Formatting DateTime values in UTC)
@@ -3649,6 +3840,8 @@ export declare const formatUtc: {
     /**
      * Format a `DateTime` as a string using the `DateTimeFormat` API.
      *
+     * **Details**
+     *
      * This forces the time zone to be UTC.
      *
      * **Example** (Formatting DateTime values in UTC)
@@ -3682,6 +3875,8 @@ export declare const formatUtc: {
     /**
      * Format a `DateTime` as a string using the `DateTimeFormat` API.
      *
+     * **Details**
+     *
      * This forces the time zone to be UTC.
      *
      * **Example** (Formatting DateTime values in UTC)
@@ -3801,6 +3996,8 @@ export declare const formatIntl: {
 /**
  * Format a `DateTime` as a UTC ISO string.
  *
+ * **Details**
+ *
  * Always returns the UTC representation in ISO 8601 format, ignoring any time zone.
  *
  * **Example** (Formatting DateTime values as ISO strings)
@@ -3824,6 +4021,8 @@ export declare const formatIso: (self: DateTime) => string;
 /**
  * Format a `DateTime` as a time zone adjusted ISO date string.
  *
+ * **Details**
+ *
  * Returns only the date part (YYYY-MM-DD) after applying time zone adjustments.
  *
  * **Example** (Formatting DateTime values as ISO dates)
@@ -3847,6 +4046,8 @@ export declare const formatIsoDate: (self: DateTime) => string;
 /**
  * Format a `DateTime` as a UTC ISO date string.
  *
+ * **Details**
+ *
  * Returns only the date part (YYYY-MM-DD) in UTC, ignoring any time zone.
  *
  * **Example** (Formatting DateTime values as UTC ISO dates)
@@ -3870,6 +4071,8 @@ export declare const formatIsoDateUtc: (self: DateTime) => string;
 /**
  * Format a `DateTime.Zoned` as an ISO string with an offset.
  *
+ * **Details**
+ *
  * For `DateTime.Utc`, returns the same as `formatIso`. For `DateTime.Zoned`,
  * includes the time zone offset in the format.
  *
@@ -3894,6 +4097,8 @@ export declare const formatIsoOffset: (self: DateTime) => string;
 /**
  * Format a `DateTime.Zoned` as a string.
  *
+ * **Details**
+ *
  * It uses the format: `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`.
  *
  * **Example** (Formatting zoned DateTime values)
@@ -3923,6 +4128,8 @@ export declare const formatIsoZoned: (self: Zoned) => string;
 /**
  * Create a Layer from the given time zone.
  *
+ * **Details**
+ *
  * This layer provides the `CurrentTimeZone` service with the specified time zone.
  *
  * **Example** (Providing current time zone layers)
@@ -3949,6 +4156,8 @@ export declare const layerCurrentZone: (resource: NoInfer<TimeZone>) => Layer.La
 /**
  * Create a Layer from the given time zone offset.
  *
+ * **Details**
+ *
  * This layer provides the `CurrentTimeZone` service with a fixed offset time zone.
  *
  * **Example** (Providing fixed-offset time zone layers)
@@ -3974,6 +4183,8 @@ export declare const layerCurrentZoneOffset: (offset: number) => Layer.Layer<Cur
 /**
  * Create a Layer from the given IANA time zone identifier.
  *
+ * **Details**
+ *
  * This layer provides the `CurrentTimeZone` service with a named time zone.
  * If the time zone identifier is invalid, the layer will fail.
  *
@@ -3999,6 +4210,8 @@ export declare const layerCurrentZoneNamed: (zoneId: string) => Layer.Layer<Curr
 /**
  * Create a Layer from the system's local time zone.
  *
+ * **Details**
+ *
  * This layer provides the `CurrentTimeZone` service using the system's
  * configured local time zone.
  *