effect 4.0.0-beta.71 → 4.0.0-beta.72

package/dist/DateTime.d.ts

@@ -411,7 +411,7 @@ export type Disambiguation = "compatible" | "earlier" | "later" | "reject";
  */
 export declare const isDateTime: (u: unknown) => u is DateTime;
 /**
- * Checks if a value is a `TimeZone`.
+ * Checks whether a value is a `TimeZone`.
  *
  * **When to use**
  *
@@ -426,7 +426,7 @@ export declare const isDateTime: (u: unknown) => u is DateTime;
  */
 export declare const isTimeZone: (u: unknown) => u is TimeZone;
 /**
- * Checks if a value is an offset-based `TimeZone`.
+ * Checks whether a value is an offset-based `TimeZone`.
  *
  * **When to use**
  *
@@ -441,7 +441,7 @@ export declare const isTimeZone: (u: unknown) => u is TimeZone;
  */
 export declare const isTimeZoneOffset: (u: unknown) => u is TimeZone.Offset;
 /**
- * Checks if a value is a named `TimeZone` (IANA time zone).
+ * Checks whether a value is a named `TimeZone` (IANA time zone).
  *
  * **When to use**
  *
@@ -456,7 +456,7 @@ export declare const isTimeZoneOffset: (u: unknown) => u is TimeZone.Offset;
  */
 export declare const isTimeZoneNamed: (u: unknown) => u is TimeZone.Named;
 /**
- * Checks if a `DateTime` is a UTC `DateTime` (no time zone information).
+ * Checks whether a `DateTime` is a UTC `DateTime` (no time zone information).
  *
  * **When to use**
  *
@@ -471,7 +471,7 @@ export declare const isTimeZoneNamed: (u: unknown) => u is TimeZone.Named;
  */
 export declare const isUtc: (self: DateTime) => self is Utc;
 /**
- * Checks if a `DateTime` is a zoned `DateTime` (has time zone information).
+ * Checks whether a `DateTime` is a zoned `DateTime` (has time zone information).
  *
  * **When to use**
  *
@@ -486,7 +486,7 @@ export declare const isUtc: (self: DateTime) => self is Utc;
  */
 export declare const isZoned: (self: DateTime) => self is Zoned;
 /**
- * An `Equivalence` for comparing two `DateTime` values for equality.
+ * Provides an `Equivalence` for comparing two `DateTime` values for equality.
  *
  * **Details**
  *
@@ -511,7 +511,7 @@ export declare const isZoned: (self: DateTime) => self is Zoned;
  */
 export declare const Equivalence: Equ.Equivalence<DateTime>;
 /**
- * An `Order` for comparing and sorting `DateTime` values.
+ * Provides an `Order` for comparing and sorting `DateTime` values.
  *
  * **Details**
  *
@@ -538,7 +538,7 @@ export declare const Equivalence: Equ.Equivalence<DateTime>;
  */
 export declare const Order: order.Order<DateTime>;
 /**
- * Clamp a `DateTime` between a minimum and maximum value.
+ * Returns a `DateTime` constrained between a minimum and maximum value.
  *
  * **Details**
  *
@@ -559,12 +559,12 @@ export declare const Order: order.Order<DateTime>;
  * // clamped equals max (2024-12-31)
  * ```
  *
- * @category instances
+ * @category ordering
  * @since 3.6.0
  */
 export declare const clamp: {
     /**
-     * Clamp a `DateTime` between a minimum and maximum value.
+     * Returns a `DateTime` constrained between a minimum and maximum value.
      *
      * **Details**
      *
@@ -585,7 +585,7 @@ export declare const clamp: {
      * // clamped equals max (2024-12-31)
      * ```
      *
-     * @category instances
+     * @category ordering
      * @since 3.6.0
      */
     <Min extends DateTime, Max extends DateTime>(options: {
@@ -593,7 +593,7 @@ export declare const clamp: {
         readonly maximum: Max;
     }): <A extends DateTime>(self: A) => A | Min | Max;
     /**
-     * Clamp a `DateTime` between a minimum and maximum value.
+     * Returns a `DateTime` constrained between a minimum and maximum value.
      *
      * **Details**
      *
@@ -614,7 +614,7 @@ export declare const clamp: {
      * // clamped equals max (2024-12-31)
      * ```
      *
-     * @category instances
+     * @category ordering
      * @since 3.6.0
      */
     <A extends DateTime, Min extends DateTime, Max extends DateTime>(self: A, options: {
@@ -714,7 +714,7 @@ export declare const makeZonedUnsafe: (input: DateTime.Input, options?: {
     readonly disambiguation?: Disambiguation | undefined;
 }) => Zoned;
 /**
- * Creates a `DateTime.Zoned` from an input and a time zone.
+ * Creates a `DateTime.Zoned` safely from an input and a time zone.
  *
  * **Details**
  *
@@ -758,7 +758,7 @@ export declare const makeZoned: (input: DateTime.Input, options?: {
     readonly disambiguation?: Disambiguation | undefined;
 }) => Option.Option<Zoned>;
 /**
- * Creates a `DateTime` from supported input values.
+ * Creates a `DateTime` safely from supported input values.
  *
  * **Details**
  *
@@ -798,7 +798,7 @@ export declare const makeZoned: (input: DateTime.Input, options?: {
  */
 export declare const make: <A extends DateTime.Input>(input: A) => Option.Option<DateTime.PreserveZone<A>>;
 /**
- * Parses an ISO zoned date-time string into a `DateTime.Zoned`.
+ * Parses an ISO zoned date-time string into a `DateTime.Zoned` safely.
  *
  * **Details**
  *
@@ -829,7 +829,7 @@ export declare const make: <A extends DateTime.Input>(input: A) => Option.Option
  */
 export declare const makeZonedFromString: (input: string) => Option.Option<Zoned>;
 /**
- * Get the current time using the `Clock` service and convert it to a `DateTime`.
+ * Gets the current time using the `Clock` service and convert it to a `DateTime`.
  *
  * **Example** (Getting the current DateTime)
  *
@@ -865,7 +865,7 @@ export declare const now: Effect.Effect<Utc>;
  */
 export declare const nowAsDate: Effect.Effect<Date>;
 /**
- * Get the current time using `Date.now`.
+ * Gets the current time using `Date.now`.
  *
  * **Details**
  *
@@ -886,7 +886,16 @@ export declare const nowAsDate: Effect.Effect<Date>;
  */
 export declare const nowUnsafe: LazyArg<Utc>;
 /**
- * For a `DateTime` returns a new `DateTime.Utc`.
+ * Converts a `DateTime` to a UTC `DateTime`.
+ *
+ * **When to use**
+ *
+ * Use to represent the same instant in UTC instead of its current time zone.
+ *
+ * **Details**
+ *
+ * The returned value keeps the same epoch milliseconds and changes only the
+ * `DateTime` representation to UTC.
  *
  * **Example** (Converting DateTime values to UTC)
  *
@@ -906,7 +915,7 @@ export declare const nowUnsafe: LazyArg<Utc>;
  */
 export declare const toUtc: (self: DateTime) => Utc;
 /**
- * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
+ * Sets the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
  *
  * **Example** (Setting time zones)
  *
@@ -927,7 +936,7 @@ export declare const toUtc: (self: DateTime) => Utc;
  */
 export declare const setZone: {
     /**
-     * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
+     * Sets the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
      *
      * **Example** (Setting time zones)
      *
@@ -951,7 +960,7 @@ export declare const setZone: {
         readonly disambiguation?: Disambiguation | undefined;
     }): (self: DateTime) => Zoned;
     /**
-     * Set the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
+     * Sets the time zone of a `DateTime`, returning a new `DateTime.Zoned`.
      *
      * **Example** (Setting time zones)
      *
@@ -976,7 +985,7 @@ export declare const setZone: {
     }): Zoned;
 };
 /**
- * Add a fixed offset time zone to a `DateTime`.
+ * Adds a fixed offset time zone to a `DateTime`.
  *
  * **Details**
  *
@@ -1000,7 +1009,7 @@ export declare const setZone: {
  */
 export declare const setZoneOffset: {
     /**
-     * Add a fixed offset time zone to a `DateTime`.
+     * Adds a fixed offset time zone to a `DateTime`.
      *
      * **Details**
      *
@@ -1027,7 +1036,7 @@ export declare const setZoneOffset: {
         readonly disambiguation?: Disambiguation | undefined;
     }): (self: DateTime) => Zoned;
     /**
-     * Add a fixed offset time zone to a `DateTime`.
+     * Adds a fixed offset time zone to a `DateTime`.
      *
      * **Details**
      *
@@ -1055,7 +1064,7 @@ export declare const setZoneOffset: {
     }): Zoned;
 };
 /**
- * Attempt to create a named time zone from a IANA time zone identifier.
+ * Attempts to create a named time zone from an IANA time zone identifier.
  *
  * **Details**
  *
@@ -1106,7 +1115,7 @@ export declare const zoneMakeNamedUnsafe: (zoneId: string) => TimeZone.Named;
  */
 export declare const zoneMakeOffset: (offset: number) => TimeZone.Offset;
 /**
- * Create a named time zone from a IANA time zone identifier.
+ * Creates a named time zone safely from an IANA time zone identifier.
  *
  * **Details**
  *
@@ -1129,7 +1138,7 @@ export declare const zoneMakeOffset: (offset: number) => TimeZone.Offset;
  */
 export declare const zoneMakeNamed: (zoneId: string) => Option.Option<TimeZone.Named>;
 /**
- * Create a named time zone from a IANA time zone identifier.
+ * Creates a named time zone effectfully from an IANA time zone identifier.
  *
  * **Details**
  *
@@ -1173,7 +1182,7 @@ export declare const zoneMakeNamedEffect: (zoneId: string) => Effect.Effect<Time
  */
 export declare const zoneMakeLocal: () => TimeZone.Named;
 /**
- * Try to parse a `TimeZone` from a string.
+ * Tries to parse a `TimeZone` from a string safely.
  *
  * **Details**
  *
@@ -1198,7 +1207,7 @@ export declare const zoneMakeLocal: () => TimeZone.Named;
  */
 export declare const zoneFromString: (zone: string) => Option.Option<TimeZone>;
 /**
- * Format a `TimeZone` as a string.
+ * Formats a `TimeZone` as a string.
  *
  * **Example** (Formatting time zones)
  *
@@ -1217,7 +1226,7 @@ export declare const zoneFromString: (zone: string) => Option.Option<TimeZone>;
  */
 export declare const zoneToString: (self: TimeZone) => string;
 /**
- * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+ * Sets the time zone of a `DateTime` safely from an IANA time zone identifier. If the
  * time zone is invalid, `None` will be returned.
  *
  * **Example** (Setting named time zones safely)
@@ -1237,7 +1246,7 @@ export declare const zoneToString: (self: TimeZone) => string;
  */
 export declare const setZoneNamed: {
     /**
-     * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+     * Sets the time zone of a `DateTime` safely from an IANA time zone identifier. If the
      * time zone is invalid, `None` will be returned.
      *
      * **Example** (Setting named time zones safely)
@@ -1260,7 +1269,7 @@ export declare const setZoneNamed: {
         readonly disambiguation?: Disambiguation | undefined;
     }): (self: DateTime) => Option.Option<Zoned>;
     /**
-     * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+     * Sets the time zone of a `DateTime` safely from an IANA time zone identifier. If the
      * time zone is invalid, `None` will be returned.
      *
      * **Example** (Setting named time zones safely)
@@ -1284,7 +1293,7 @@ export declare const setZoneNamed: {
     }): Option.Option<Zoned>;
 };
 /**
- * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+ * Sets the time zone of a `DateTime` from an IANA time zone identifier. If the
  * time zone is invalid, an `IllegalArgumentError` will be thrown.
  *
  * **Example** (Setting named time zones unsafely)
@@ -1304,7 +1313,7 @@ export declare const setZoneNamed: {
  */
 export declare const setZoneNamedUnsafe: {
     /**
-     * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+     * Sets the time zone of a `DateTime` from an IANA time zone identifier. If the
      * time zone is invalid, an `IllegalArgumentError` will be thrown.
      *
      * **Example** (Setting named time zones unsafely)
@@ -1327,7 +1336,7 @@ export declare const setZoneNamedUnsafe: {
         readonly disambiguation?: Disambiguation | undefined;
     }): (self: DateTime) => Zoned;
     /**
-     * Set the time zone of a `DateTime` from an IANA time zone identifier. If the
+     * Sets the time zone of a `DateTime` from an IANA time zone identifier. If the
      * time zone is invalid, an `IllegalArgumentError` will be thrown.
      *
      * **Example** (Setting named time zones unsafely)
@@ -1351,7 +1360,7 @@ export declare const setZoneNamedUnsafe: {
     }): Zoned;
 };
 /**
- * Calulate the difference between two `DateTime` values, returning a
+ * Computes the difference between two `DateTime` values, returning a
  * `Duration` representing the amount of time between them.
  *
  * **Details**
@@ -1379,7 +1388,7 @@ export declare const setZoneNamedUnsafe: {
  */
 export declare const distance: {
     /**
-     * Calulate the difference between two `DateTime` values, returning a
+     * Computes the difference between two `DateTime` values, returning a
      * `Duration` representing the amount of time between them.
      *
      * **Details**
@@ -1407,7 +1416,7 @@ export declare const distance: {
      */
     (other: DateTime): (self: DateTime) => Duration.Duration;
     /**
-     * Calulate the difference between two `DateTime` values, returning a
+     * Computes the difference between two `DateTime` values, returning a
      * `Duration` representing the amount of time between them.
      *
      * **Details**
@@ -1552,7 +1561,7 @@ export declare const max: {
     <Self extends DateTime, That extends DateTime>(self: Self, that: That): Self | That;
 };
 /**
- * Checks if the first `DateTime` is after the second `DateTime`.
+ * Checks whether the first `DateTime` is after the second `DateTime`.
  *
  * **Example** (Checking whether a DateTime is later)
  *
@@ -1571,7 +1580,7 @@ export declare const max: {
  */
 export declare const isGreaterThan: {
     /**
-     * Checks if the first `DateTime` is after the second `DateTime`.
+     * Checks whether the first `DateTime` is after the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is later)
      *
@@ -1590,7 +1599,7 @@ export declare const isGreaterThan: {
      */
     (that: DateTime): (self: DateTime) => boolean;
     /**
-     * Checks if the first `DateTime` is after the second `DateTime`.
+     * Checks whether the first `DateTime` is after the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is later)
      *
@@ -1610,7 +1619,7 @@ export declare const isGreaterThan: {
     (self: DateTime, that: DateTime): boolean;
 };
 /**
- * Checks if the first `DateTime` is after or equal to the second `DateTime`.
+ * Checks whether the first `DateTime` is after or equal to the second `DateTime`.
  *
  * **Example** (Checking whether a DateTime is later or equal)
  *
@@ -1631,7 +1640,7 @@ export declare const isGreaterThan: {
  */
 export declare const isGreaterThanOrEqualTo: {
     /**
-     * Checks if the first `DateTime` is after or equal to the second `DateTime`.
+     * Checks whether the first `DateTime` is after or equal to the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is later or equal)
      *
@@ -1652,7 +1661,7 @@ export declare const isGreaterThanOrEqualTo: {
      */
     (that: DateTime): (self: DateTime) => boolean;
     /**
-     * Checks if the first `DateTime` is after or equal to the second `DateTime`.
+     * Checks whether the first `DateTime` is after or equal to the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is later or equal)
      *
@@ -1674,7 +1683,7 @@ export declare const isGreaterThanOrEqualTo: {
     (self: DateTime, that: DateTime): boolean;
 };
 /**
- * Checks if the first `DateTime` is before the second `DateTime`.
+ * Checks whether the first `DateTime` is before the second `DateTime`.
  *
  * **Example** (Checking whether a DateTime is earlier)
  *
@@ -1693,7 +1702,7 @@ export declare const isGreaterThanOrEqualTo: {
  */
 export declare const isLessThan: {
     /**
-     * Checks if the first `DateTime` is before the second `DateTime`.
+     * Checks whether the first `DateTime` is before the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is earlier)
      *
@@ -1712,7 +1721,7 @@ export declare const isLessThan: {
      */
     (that: DateTime): (self: DateTime) => boolean;
     /**
-     * Checks if the first `DateTime` is before the second `DateTime`.
+     * Checks whether the first `DateTime` is before the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is earlier)
      *
@@ -1732,7 +1741,7 @@ export declare const isLessThan: {
     (self: DateTime, that: DateTime): boolean;
 };
 /**
- * Checks if the first `DateTime` is before or equal to the second `DateTime`.
+ * Checks whether the first `DateTime` is before or equal to the second `DateTime`.
  *
  * **Example** (Checking whether a DateTime is earlier or equal)
  *
@@ -1753,7 +1762,7 @@ export declare const isLessThan: {
  */
 export declare const isLessThanOrEqualTo: {
     /**
-     * Checks if the first `DateTime` is before or equal to the second `DateTime`.
+     * Checks whether the first `DateTime` is before or equal to the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is earlier or equal)
      *
@@ -1774,7 +1783,7 @@ export declare const isLessThanOrEqualTo: {
      */
     (that: DateTime): (self: DateTime) => boolean;
     /**
-     * Checks if the first `DateTime` is before or equal to the second `DateTime`.
+     * Checks whether the first `DateTime` is before or equal to the second `DateTime`.
      *
      * **Example** (Checking whether a DateTime is earlier or equal)
      *
@@ -1796,7 +1805,7 @@ export declare const isLessThanOrEqualTo: {
     (self: DateTime, that: DateTime): boolean;
 };
 /**
- * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
+ * Checks whether a `DateTime` is between two other `DateTime` values (inclusive).
  *
  * **Example** (Checking whether a DateTime is within bounds)
  *
@@ -1815,7 +1824,7 @@ export declare const isLessThanOrEqualTo: {
  */
 export declare const between: {
     /**
-     * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
+     * Checks whether a `DateTime` is between two other `DateTime` values (inclusive).
      *
      * **Example** (Checking whether a DateTime is within bounds)
      *
@@ -1837,7 +1846,7 @@ export declare const between: {
         maximum: DateTime;
     }): (self: DateTime) => boolean;
     /**
-     * Checks if a `DateTime` is between two other `DateTime` values (inclusive).
+     * Checks whether a `DateTime` is between two other `DateTime` values (inclusive).
      *
      * **Example** (Checking whether a DateTime is within bounds)
      *
@@ -1860,7 +1869,7 @@ export declare const between: {
     }): boolean;
 };
 /**
- * Checks if a `DateTime` is in the future compared to the current time.
+ * Checks effectfully if a `DateTime` is in the future compared to the current time.
  *
  * **Details**
  *
@@ -1883,7 +1892,7 @@ export declare const between: {
  */
 export declare const isFuture: (self: DateTime) => Effect.Effect<boolean>;
 /**
- * Checks if a `DateTime` is in the future compared to the current time.
+ * Checks synchronously if a `DateTime` is in the future compared to the current time.
  *
  * **Details**
  *
@@ -1906,7 +1915,7 @@ export declare const isFuture: (self: DateTime) => Effect.Effect<boolean>;
  */
 export declare const isFutureUnsafe: (self: DateTime) => boolean;
 /**
- * Checks if a `DateTime` is in the past compared to the current time.
+ * Checks effectfully if a `DateTime` is in the past compared to the current time.
  *
  * **Details**
  *
@@ -1929,7 +1938,7 @@ export declare const isFutureUnsafe: (self: DateTime) => boolean;
  */
 export declare const isPast: (self: DateTime) => Effect.Effect<boolean>;
 /**
- * Checks if a `DateTime` is in the past compared to the current time.
+ * Checks synchronously if a `DateTime` is in the past compared to the current time.
  *
  * **Details**
  *
@@ -1952,7 +1961,7 @@ export declare const isPast: (self: DateTime) => Effect.Effect<boolean>;
  */
 export declare const isPastUnsafe: (self: DateTime) => boolean;
 /**
- * Get the UTC `Date` of a `DateTime`.
+ * Gets the UTC `Date` of a `DateTime`.
  *
  * **Details**
  *
@@ -1976,7 +1985,7 @@ export declare const isPastUnsafe: (self: DateTime) => boolean;
  */
 export declare const toDateUtc: (self: DateTime) => Date;
 /**
- * Convert a `DateTime` to a `Date`, applying the time zone first.
+ * Converts a `DateTime` to a `Date`, applying the time zone first.
  *
  * **Details**
  *
@@ -2002,7 +2011,7 @@ export declare const toDateUtc: (self: DateTime) => Date;
  */
 export declare const toDate: (self: DateTime) => Date;
 /**
- * Calculate the time zone offset of a `DateTime.Zoned` in milliseconds.
+ * Computes the time zone offset of a `DateTime.Zoned` in milliseconds.
  *
  * **Details**
  *
@@ -2027,7 +2036,7 @@ export declare const toDate: (self: DateTime) => Date;
  */
 export declare const zonedOffset: (self: Zoned) => number;
 /**
- * Format the time zone offset of a `DateTime.Zoned` as an ISO string.
+ * Formats the time zone offset of a `DateTime.Zoned` as an ISO string.
  *
  * **Details**
  *
@@ -2051,7 +2060,7 @@ export declare const zonedOffset: (self: Zoned) => number;
  */
 export declare const zonedOffsetIso: (self: Zoned) => string;
 /**
- * Get the milliseconds since the Unix epoch of a `DateTime`.
+ * Gets the milliseconds since the Unix epoch of a `DateTime`.
  *
  * **Details**
  *
@@ -2073,7 +2082,7 @@ export declare const zonedOffsetIso: (self: Zoned) => string;
  */
 export declare const toEpochMillis: (self: DateTime) => number;
 /**
- * Remove the time aspect of a `DateTime`, first adjusting for the time
+ * Removes the time aspect of a `DateTime`, first adjusting for the time
  * zone. It will return a `DateTime.Utc` only containing the date.
  *
  * **Example** (Removing time components)
@@ -2096,7 +2105,7 @@ export declare const toEpochMillis: (self: DateTime) => number;
  */
 export declare const removeTime: (self: DateTime) => Utc;
 /**
- * Get the different parts of a `DateTime` as an object.
+ * Gets the time-zone-adjusted parts of a `DateTime` as an object.
  *
  * **Details**
  *
@@ -2128,7 +2137,7 @@ export declare const removeTime: (self: DateTime) => Utc;
  */
 export declare const toParts: (self: DateTime) => DateTime.PartsWithWeekday;
 /**
- * Get the different parts of a `DateTime` as an object.
+ * Gets the UTC parts of a `DateTime` as an object.
  *
  * **Details**
  *
@@ -2153,7 +2162,7 @@ export declare const toParts: (self: DateTime) => DateTime.PartsWithWeekday;
  */
 export declare const toPartsUtc: (self: DateTime) => DateTime.PartsWithWeekday;
 /**
- * Get a part of a `DateTime` as a number.
+ * Gets one UTC part of a `DateTime` as a number.
  *
  * **Details**
  *
@@ -2174,7 +2183,7 @@ export declare const toPartsUtc: (self: DateTime) => DateTime.PartsWithWeekday;
  */
 export declare const getPartUtc: {
     /**
-     * Get a part of a `DateTime` as a number.
+     * Gets one UTC part of a `DateTime` as a number.
      *
      * **Details**
      *
@@ -2195,7 +2204,7 @@ export declare const getPartUtc: {
      */
     (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number;
     /**
-     * Get a part of a `DateTime` as a number.
+     * Gets one UTC part of a `DateTime` as a number.
      *
      * **Details**
      *
@@ -2217,7 +2226,7 @@ export declare const getPartUtc: {
     (self: DateTime, part: keyof DateTime.PartsWithWeekday): number;
 };
 /**
- * Get a part of a `DateTime` as a number.
+ * Gets one time-zone-adjusted part of a `DateTime` as a number.
  *
  * **Details**
  *
@@ -2240,7 +2249,7 @@ export declare const getPartUtc: {
  */
 export declare const getPart: {
     /**
-     * Get a part of a `DateTime` as a number.
+     * Gets one time-zone-adjusted part of a `DateTime` as a number.
      *
      * **Details**
      *
@@ -2263,7 +2272,7 @@ export declare const getPart: {
      */
     (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number;
     /**
-     * Get a part of a `DateTime` as a number.
+     * Gets one time-zone-adjusted part of a `DateTime` as a number.
      *
      * **Details**
      *
@@ -2287,7 +2296,7 @@ export declare const getPart: {
     (self: DateTime, part: keyof DateTime.PartsWithWeekday): number;
 };
 /**
- * Set the different parts of a `DateTime` as an object.
+ * Sets time-zone-adjusted parts on a `DateTime`.
  *
  * **Details**
  *
@@ -2313,7 +2322,7 @@ export declare const getPart: {
  */
 export declare const setParts: {
     /**
-     * Set the different parts of a `DateTime` as an object.
+     * Sets time-zone-adjusted parts on a `DateTime`.
      *
      * **Details**
      *
@@ -2339,7 +2348,7 @@ export declare const setParts: {
      */
     (parts: Partial<DateTime.PartsWithWeekday>): <A extends DateTime>(self: A) => A;
     /**
-     * Set the different parts of a `DateTime` as an object.
+     * Sets time-zone-adjusted parts on a `DateTime`.
      *
      * **Details**
      *
@@ -2366,7 +2375,7 @@ export declare const setParts: {
     <A extends DateTime>(self: A, parts: Partial<DateTime.PartsWithWeekday>): A;
 };
 /**
- * Set the different parts of a `DateTime` as an object.
+ * Sets UTC parts on a `DateTime`.
  *
  * **Details**
  *
@@ -2391,7 +2400,7 @@ export declare const setParts: {
  */
 export declare const setPartsUtc: {
     /**
-     * Set the different parts of a `DateTime` as an object.
+     * Sets UTC parts on a `DateTime`.
      *
      * **Details**
      *
@@ -2416,7 +2425,7 @@ export declare const setPartsUtc: {
      */
     (parts: Partial<DateTime.PartsWithWeekday>): <A extends DateTime>(self: A) => A;
     /**
-     * Set the different parts of a `DateTime` as an object.
+     * Sets UTC parts on a `DateTime`.
      *
      * **Details**
      *
@@ -2474,7 +2483,7 @@ declare const CurrentTimeZone_base: Context.ServiceClass<CurrentTimeZone, "effec
 export declare class CurrentTimeZone extends CurrentTimeZone_base {
 }
 /**
- * Set the time zone of a `DateTime` to the current time zone, which is
+ * Sets the time zone of a `DateTime` to the current time zone, which is
  * determined by the `CurrentTimeZone` service.
  *
  * **Example** (Setting the current time zone)
@@ -2495,7 +2504,7 @@ export declare class CurrentTimeZone extends CurrentTimeZone_base {
  */
 export declare const setZoneCurrent: (self: DateTime) => Effect.Effect<Zoned, never, CurrentTimeZone>;
 /**
- * Provide the `CurrentTimeZone` to an effect.
+ * Provides the `CurrentTimeZone` to an effect.
  *
  * **Example** (Providing the current time zone)
  *
@@ -2514,7 +2523,7 @@ export declare const setZoneCurrent: (self: DateTime) => Effect.Effect<Zoned, ne
  */
 export declare const withCurrentZone: {
     /**
-     * Provide the `CurrentTimeZone` to an effect.
+     * Provides the `CurrentTimeZone` to an effect.
      *
      * **Example** (Providing the current time zone)
      *
@@ -2533,7 +2542,7 @@ export declare const withCurrentZone: {
      */
     (value: TimeZone): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
     /**
-     * Provide the `CurrentTimeZone` to an effect.
+     * Provides the `CurrentTimeZone` to an effect.
      *
      * **Example** (Providing the current time zone)
      *
@@ -2553,7 +2562,7 @@ export declare const withCurrentZone: {
     <A, E, R>(self: Effect.Effect<A, E, R>, value: TimeZone): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
 };
 /**
- * Provide the `CurrentTimeZone` to an effect, using the system's local time
+ * Provides the `CurrentTimeZone` to an effect, using the system's local time
  * zone.
  *
  * **Example** (Providing the local time zone)
@@ -2572,7 +2581,7 @@ export declare const withCurrentZone: {
  */
 export declare const withCurrentZoneLocal: <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
 /**
- * Provide the `CurrentTimeZone` to an effect, using a offset.
+ * Provides the `CurrentTimeZone` to an effect, using an offset.
  *
  * **Example** (Providing a fixed-offset time zone)
  *
@@ -2590,7 +2599,7 @@ export declare const withCurrentZoneLocal: <A, E, R>(effect: Effect.Effect<A, E,
  */
 export declare const withCurrentZoneOffset: {
     /**
-     * Provide the `CurrentTimeZone` to an effect, using a offset.
+     * Provides the `CurrentTimeZone` to an effect, using an offset.
      *
      * **Example** (Providing a fixed-offset time zone)
      *
@@ -2608,7 +2617,7 @@ export declare const withCurrentZoneOffset: {
      */
     (offset: number): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
     /**
-     * Provide the `CurrentTimeZone` to an effect, using a offset.
+     * Provides the `CurrentTimeZone` to an effect, using an offset.
      *
      * **Example** (Providing a fixed-offset time zone)
      *
@@ -2627,7 +2636,7 @@ export declare const withCurrentZoneOffset: {
     <A, E, R>(effect: Effect.Effect<A, E, R>, offset: number): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>;
 };
 /**
- * Provide the `CurrentTimeZone` to an effect using an IANA time zone
+ * Provides the `CurrentTimeZone` to an effect using an IANA time zone
  * identifier.
  *
  * **Details**
@@ -2650,7 +2659,7 @@ export declare const withCurrentZoneOffset: {
  */
 export declare const withCurrentZoneNamed: {
     /**
-     * Provide the `CurrentTimeZone` to an effect using an IANA time zone
+     * Provides the `CurrentTimeZone` to an effect using an IANA time zone
      * identifier.
      *
      * **Details**
@@ -2673,7 +2682,7 @@ export declare const withCurrentZoneNamed: {
      */
     (zone: string): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E | IllegalArgumentError, Exclude<R, CurrentTimeZone>>;
     /**
-     * Provide the `CurrentTimeZone` to an effect using an IANA time zone
+     * Provides the `CurrentTimeZone` to an effect using an IANA time zone
      * identifier.
      *
      * **Details**
@@ -2697,7 +2706,7 @@ export declare const withCurrentZoneNamed: {
     <A, E, R>(effect: Effect.Effect<A, E, R>, zone: string): Effect.Effect<A, E | IllegalArgumentError, Exclude<R, CurrentTimeZone>>;
 };
 /**
- * Get the current time as a `DateTime.Zoned`, using the `CurrentTimeZone`.
+ * Gets the current time as a `DateTime.Zoned`, using the `CurrentTimeZone`.
  *
  * **Example** (Getting the current time in the current zone)
  *
@@ -2715,7 +2724,12 @@ export declare const withCurrentZoneNamed: {
  */
 export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZone>;
 /**
- * Modify a `DateTime` by applying a function to a cloned `Date` instance.
+ * Modifies a `DateTime` with a mutable local `Date` copy.
+ *
+ * **When to use**
+ *
+ * Use to adjust calendar fields in the `DateTime`'s own time zone with an
+ * existing `Date` mutation API.
  *
  * **Details**
  *
@@ -2744,7 +2758,12 @@ export declare const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZo
  */
 export declare const mutate: {
     /**
-     * Modify a `DateTime` by applying a function to a cloned `Date` instance.
+     * Modifies a `DateTime` with a mutable local `Date` copy.
+     *
+     * **When to use**
+     *
+     * Use to adjust calendar fields in the `DateTime`'s own time zone with an
+     * existing `Date` mutation API.
      *
      * **Details**
      *
@@ -2775,7 +2794,12 @@ export declare const mutate: {
         readonly disambiguation?: Disambiguation | undefined;
     }): <A extends DateTime>(self: A) => A;
     /**
-     * Modify a `DateTime` by applying a function to a cloned `Date` instance.
+     * Modifies a `DateTime` with a mutable local `Date` copy.
+     *
+     * **When to use**
+     *
+     * Use to adjust calendar fields in the `DateTime`'s own time zone with an
+     * existing `Date` mutation API.
      *
      * **Details**
      *
@@ -2807,7 +2831,12 @@ export declare const mutate: {
     }): A;
 };
 /**
- * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
+ * Modifies a `DateTime` with a mutable UTC `Date` copy.
+ *
+ * **When to use**
+ *
+ * Use to adjust the instant with an existing `Date` mutation API that works on
+ * UTC calendar fields.
  *
  * **Example** (Mutating DateTime values with UTC Dates)
  *
@@ -2830,7 +2859,12 @@ export declare const mutate: {
  */
 export declare const mutateUtc: {
     /**
-     * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
+     * Modifies a `DateTime` with a mutable UTC `Date` copy.
+     *
+     * **When to use**
+     *
+     * Use to adjust the instant with an existing `Date` mutation API that works on
+     * UTC calendar fields.
      *
      * **Example** (Mutating DateTime values with UTC Dates)
      *
@@ -2853,7 +2887,12 @@ export declare const mutateUtc: {
      */
     (f: (date: Date) => void): <A extends DateTime>(self: A) => A;
     /**
-     * Modify a `DateTime` by applying a function to a cloned UTC `Date` instance.
+     * Modifies a `DateTime` with a mutable UTC `Date` copy.
+     *
+     * **When to use**
+     *
+     * Use to adjust the instant with an existing `Date` mutation API that works on
+     * UTC calendar fields.
      *
      * **Example** (Mutating DateTime values with UTC Dates)
      *
@@ -2877,7 +2916,7 @@ export declare const mutateUtc: {
     <A extends DateTime>(self: A, f: (date: Date) => void): A;
 };
 /**
- * Transform a `DateTime` by applying a function to the number of milliseconds
+ * Transforms a `DateTime` by applying a function to the number of milliseconds
  * since the Unix epoch.
  *
  * **Example** (Mapping epoch milliseconds)
@@ -2896,7 +2935,7 @@ export declare const mutateUtc: {
  */
 export declare const mapEpochMillis: {
     /**
-     * Transform a `DateTime` by applying a function to the number of milliseconds
+     * Transforms a `DateTime` by applying a function to the number of milliseconds
      * since the Unix epoch.
      *
      * **Example** (Mapping epoch milliseconds)
@@ -2915,7 +2954,7 @@ export declare const mapEpochMillis: {
      */
     (f: (millis: number) => number): <A extends DateTime>(self: A) => A;
     /**
-     * Transform a `DateTime` by applying a function to the number of milliseconds
+     * Transforms a `DateTime` by applying a function to the number of milliseconds
      * since the Unix epoch.
      *
      * **Example** (Mapping epoch milliseconds)
@@ -3184,7 +3223,7 @@ export declare const match: {
     }): A | B;
 };
 /**
- * Add the given `Duration` to a `DateTime`.
+ * Adds the given `Duration` to a `DateTime`.
  *
  * **When to use**
  *
@@ -3221,7 +3260,7 @@ export declare const match: {
  */
 export declare const addDuration: {
     /**
-     * Add the given `Duration` to a `DateTime`.
+     * Adds the given `Duration` to a `DateTime`.
      *
      * **When to use**
      *
@@ -3258,7 +3297,7 @@ export declare const addDuration: {
      */
     (duration: Duration.Input): <A extends DateTime>(self: A) => A;
     /**
-     * Add the given `Duration` to a `DateTime`.
+     * Adds the given `Duration` to a `DateTime`.
      *
      * **When to use**
      *
@@ -3296,7 +3335,7 @@ export declare const addDuration: {
     <A extends DateTime>(self: A, duration: Duration.Input): A;
 };
 /**
- * Subtract the given `Duration` from a `DateTime`.
+ * Subtracts the given `Duration` from a `DateTime`.
  *
  * **Example** (Subtracting durations)
  *
@@ -3314,7 +3353,7 @@ export declare const addDuration: {
  */
 export declare const subtractDuration: {
     /**
-     * Subtract the given `Duration` from a `DateTime`.
+     * Subtracts the given `Duration` from a `DateTime`.
      *
      * **Example** (Subtracting durations)
      *
@@ -3332,7 +3371,7 @@ export declare const subtractDuration: {
      */
     (duration: Duration.Input): <A extends DateTime>(self: A) => A;
     /**
-     * Subtract the given `Duration` from a `DateTime`.
+     * Subtracts the given `Duration` from a `DateTime`.
      *
      * **Example** (Subtracting durations)
      *
@@ -3351,7 +3390,7 @@ export declare const subtractDuration: {
     <A extends DateTime>(self: A, duration: Duration.Input): A;
 };
 /**
- * Add the given `amount` of `unit`'s to a `DateTime`.
+ * Adds the given `amount` of `unit` to a `DateTime`.
  *
  * **Details**
  *
@@ -3374,7 +3413,7 @@ export declare const subtractDuration: {
  */
 export declare const add: {
     /**
-     * Add the given `amount` of `unit`'s to a `DateTime`.
+     * Adds the given `amount` of `unit` to a `DateTime`.
      *
      * **Details**
      *
@@ -3397,7 +3436,7 @@ export declare const add: {
      */
     (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => A;
     /**
-     * Add the given `amount` of `unit`'s to a `DateTime`.
+     * Adds the given `amount` of `unit` to a `DateTime`.
      *
      * **Details**
      *
@@ -3421,7 +3460,7 @@ export declare const add: {
     <A extends DateTime>(self: A, parts: Partial<DateTime.PartsForMath>): A;
 };
 /**
- * Subtract the given `amount` of `unit`'s from a `DateTime`.
+ * Subtracts the given `amount` of `unit` from a `DateTime`.
  *
  * **Example** (Subtracting date and time parts)
  *
@@ -3439,7 +3478,7 @@ export declare const add: {
  */
 export declare const subtract: {
     /**
-     * Subtract the given `amount` of `unit`'s from a `DateTime`.
+     * Subtracts the given `amount` of `unit` from a `DateTime`.
      *
      * **Example** (Subtracting date and time parts)
      *
@@ -3457,7 +3496,7 @@ export declare const subtract: {
      */
     (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => A;
     /**
-     * Subtract the given `amount` of `unit`'s from a `DateTime`.
+     * Subtracts the given `amount` of `unit` from a `DateTime`.
      *
      * **Example** (Subtracting date and time parts)
      *
@@ -3814,7 +3853,8 @@ export declare const format: {
     } | undefined): string;
 };
 /**
- * Format a `DateTime` as a string using the `DateTimeFormat` API.
+ * Formats a `DateTime` with `Intl.DateTimeFormat` using the system local time
+ * zone and locale.
  *
  * **Details**
  *
@@ -3844,7 +3884,8 @@ export declare const format: {
  */
 export declare const formatLocal: {
     /**
-     * Format a `DateTime` as a string using the `DateTimeFormat` API.
+     * Formats a `DateTime` with `Intl.DateTimeFormat` using the system local time
+     * zone and locale.
      *
      * **Details**
      *
@@ -3876,7 +3917,8 @@ export declare const formatLocal: {
         readonly locale?: string | undefined;
     } | undefined): (self: DateTime) => string;
     /**
-     * Format a `DateTime` as a string using the `DateTimeFormat` API.
+     * Formats a `DateTime` with `Intl.DateTimeFormat` using the system local time
+     * zone and locale.
      *
      * **Details**
      *
@@ -3909,7 +3951,7 @@ export declare const formatLocal: {
     } | undefined): string;
 };
 /**
- * Format a `DateTime` as a string using the `DateTimeFormat` API.
+ * Formats a `DateTime` with `Intl.DateTimeFormat` using the UTC time zone.
  *
  * **Details**
  *
@@ -3942,7 +3984,7 @@ export declare const formatLocal: {
  */
 export declare const formatUtc: {
     /**
-     * Format a `DateTime` as a string using the `DateTimeFormat` API.
+     * Formats a `DateTime` with `Intl.DateTimeFormat` using the UTC time zone.
      *
      * **Details**
      *
@@ -3977,7 +4019,7 @@ export declare const formatUtc: {
         readonly locale?: string | undefined;
     } | undefined): (self: DateTime) => string;
     /**
-     * Format a `DateTime` as a string using the `DateTimeFormat` API.
+     * Formats a `DateTime` with `Intl.DateTimeFormat` using the UTC time zone.
      *
      * **Details**
      *
@@ -4137,7 +4179,7 @@ export declare const formatIntl: {
     (self: DateTime, format: Intl.DateTimeFormat): string;
 };
 /**
- * Format a `DateTime` as a UTC ISO string.
+ * Formats a `DateTime` as a UTC ISO string.
  *
  * **Details**
  *
@@ -4162,7 +4204,7 @@ export declare const formatIntl: {
  */
 export declare const formatIso: (self: DateTime) => string;
 /**
- * Format a `DateTime` as a time zone adjusted ISO date string.
+ * Formats a `DateTime` as a time zone adjusted ISO date string.
  *
  * **Details**
  *
@@ -4187,7 +4229,7 @@ export declare const formatIso: (self: DateTime) => string;
  */
 export declare const formatIsoDate: (self: DateTime) => string;
 /**
- * Format a `DateTime` as a UTC ISO date string.
+ * Formats a `DateTime` as a UTC ISO date string.
  *
  * **Details**
  *
@@ -4212,7 +4254,7 @@ export declare const formatIsoDate: (self: DateTime) => string;
  */
 export declare const formatIsoDateUtc: (self: DateTime) => string;
 /**
- * Format a `DateTime.Zoned` as an ISO string with an offset.
+ * Formats a `DateTime.Zoned` as an ISO string with an offset.
  *
  * **Details**
  *
@@ -4238,7 +4280,7 @@ export declare const formatIsoDateUtc: (self: DateTime) => string;
  */
 export declare const formatIsoOffset: (self: DateTime) => string;
 /**
- * Format a `DateTime.Zoned` as a string.
+ * Formats a `DateTime.Zoned` as a string.
  *
  * **Details**
  *