effect 4.0.1 → 4.0.2

package/dist/DateTime.js

@@ -19,6 +19,7 @@ const TimeZoneTypeId = Internal.TimeZoneTypeId;
  * @see {@link isUtc} for narrowing a known `DateTime` to UTC
  * @see {@link isZoned} for narrowing a known `DateTime` to zoned
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -34,6 +35,7 @@ export const isDateTime = Internal.isDateTime;
  * @see {@link isTimeZoneOffset} for narrowing to fixed-offset time zones
  * @see {@link isTimeZoneNamed} for narrowing to named time zones
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -49,6 +51,7 @@ export const isTimeZone = Internal.isTimeZone;
  * @see {@link isTimeZone} for checking either time zone variant
  * @see {@link isTimeZoneNamed} for narrowing to named time zones
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -64,6 +67,7 @@ export const isTimeZoneOffset = Internal.isTimeZoneOffset;
  * @see {@link isTimeZone} for checking either time zone variant
  * @see {@link isTimeZoneOffset} for narrowing to fixed-offset time zones
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -79,6 +83,7 @@ export const isTimeZoneNamed = Internal.isTimeZoneNamed;
  * @see {@link isZoned} for narrowing to zoned date-times
  * @see {@link match} for handling both UTC and zoned cases
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -94,6 +99,7 @@ export const isUtc = Internal.isUtc;
  * @see {@link isUtc} for narrowing to UTC date-times
  * @see {@link match} for handling both UTC and zoned cases
  *
+ * @stability stable
  * @category guards
  * @since 3.6.0
  */
@@ -122,6 +128,7 @@ export const isZoned = Internal.isZoned;
  * DateTime.Equivalence(utc, zoned) // => true
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 3.6.0
  */
@@ -148,6 +155,7 @@ export const Equivalence = Internal.Equivalence;
  * Array.sort(dates, DateTime.Order).map(DateTime.formatIsoDateUtc) // => ["2024-01-01", "2024-02-01", "2024-03-01"]
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 3.6.0
  */
@@ -173,6 +181,7 @@ export const Order = Internal.Order;
  * DateTime.clamp(date, { minimum: min, maximum: max }) // => DateTime.makeUnsafe("2024-12-31")
  * ```
  *
+ * @stability stable
  * @category ordering
  * @since 3.6.0
  */
@@ -195,6 +204,7 @@ export const clamp = Internal.clamp;
  * DateTime.fromDateUnsafe(new Date("2024-01-01T12:00:00Z")) // => DateTime.makeUnsafe("2024-01-01T12:00:00Z")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -230,6 +240,7 @@ export const fromDateUnsafe = Internal.fromDateUnsafe;
  * DateTime.makeUnsafe("2024-01-01") // => DateTime.makeUnsafe("2024-01-01T00:00:00Z")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -245,6 +256,7 @@ export const makeUnsafe = Internal.makeUnsafe;
  * DateTime.fromEpochSeconds(1704067200).toJSON() // => "2024-01-01T00:00:00.000Z"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -282,6 +294,7 @@ export const fromEpochSeconds = Internal.fromEpochSeconds;
  * DateTime.formatIsoZoned(zoned) // => "2024-06-15T15:30:00.000+01:00[Europe/London]"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -319,6 +332,7 @@ export const makeZonedUnsafe = Internal.makeZonedUnsafe;
  * result.pipe(Option.map(DateTime.formatIsoZoned)) // => Option.some("2024-06-15T15:30:00.000+01:00[Europe/London]")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -355,6 +369,7 @@ export const makeZoned = Internal.makeZoned;
  * DateTime.make("not a date") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -382,6 +397,7 @@ export const make = Internal.make;
  * DateTime.makeZonedFromString("invalid") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -398,6 +414,7 @@ export const makeZonedFromString = Internal.makeZonedFromString;
  * await Effect.runPromise(Effect.map(DateTime.now, DateTime.isDateTime)) // => true
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -415,6 +432,7 @@ export const now = Internal.now;
  * await Effect.runPromise(Effect.map(DateTime.nowAsDate, (now) => now instanceof Date)) // => true
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.14.0
  */
@@ -440,6 +458,7 @@ export const nowAsDate = Internal.nowAsDate;
  * Number.isFinite(DateTime.toEpochMillis(DateTime.nowUnsafe())) // => true
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -473,6 +492,7 @@ export const nowUnsafe = Internal.nowUnsafe;
  * utc // => DateTime.makeUnsafe("2024-01-01T00:00:00Z")
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.13.0
  */
@@ -491,6 +511,7 @@ export const toUtc = Internal.toUtc;
  * DateTime.isZoned(zoned) // => true
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 3.6.0
  */
@@ -513,6 +534,7 @@ export const setZone = Internal.setZone;
  * DateTime.zoneToString(zoned.zone) // => "+03:00"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 3.6.0
  */
@@ -541,6 +563,7 @@ export const setZoneOffset = Internal.setZoneOffset;
  * // DateTime.zoneMakeNamedUnsafe("Invalid/Zone")
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -567,6 +590,7 @@ export const zoneMakeNamedUnsafe = Internal.zoneMakeNamedUnsafe;
  * DateTime.formatIsoZoned(dt) // => "2024-01-01T15:00:00.000+03:00"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -587,6 +611,7 @@ export const zoneMakeOffset = Internal.zoneMakeOffset;
  * DateTime.zoneMakeNamed("Invalid/Zone") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -613,6 +638,7 @@ export const zoneMakeNamed = Internal.zoneMakeNamed;
  * DateTime.zoneToString((await Effect.runPromise(program)).zone) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -633,6 +659,7 @@ export const zoneMakeNamedEffect = Internal.zoneMakeNamedEffect;
  * DateTime.isTimeZoneNamed(DateTime.zoneMakeLocal()) // => true
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.6.0
  */
@@ -654,6 +681,7 @@ export const zoneMakeLocal = Internal.zoneMakeLocal;
  * DateTime.zoneFromString("invalid") // => Option.none()
  * ```
  *
+ * @stability stable
  * @category decoding
  * @since 3.6.0
  */
@@ -670,6 +698,7 @@ export const zoneFromString = Internal.zoneFromString;
  * DateTime.zoneToString(DateTime.zoneMakeNamedUnsafe("Europe/London")) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category encoding
  * @since 3.6.0
  */
@@ -689,6 +718,7 @@ export const zoneToString = Internal.zoneToString;
  * result // => Option.some("2024-01-01T00:00:00.000+00:00[Europe/London]")
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 3.6.0
  */
@@ -708,6 +738,7 @@ export const setZoneNamed = Internal.setZoneNamed;
  * DateTime.zoneToString(zoned.zone) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 4.0.0
  */
@@ -736,6 +767,7 @@ export const setZoneNamedUnsafe = Internal.setZoneNamedUnsafe;
  * DateTime.distance(start, end) // => Duration.minutes(1)
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -754,6 +786,7 @@ export const distance = Internal.distance;
  * DateTime.min(date1, date2) // => DateTime.makeUnsafe("2024-01-01")
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -772,6 +805,7 @@ export const min = Internal.min;
  * DateTime.max(date1, date2) // => DateTime.makeUnsafe("2024-02-01")
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -791,6 +825,7 @@ export const max = Internal.max;
  * DateTime.isGreaterThan(date2, date1) // => false
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -812,6 +847,7 @@ export const isGreaterThan = Internal.isGreaterThan;
  * DateTime.isGreaterThanOrEqualTo(date1, date3) // => false
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -831,6 +867,7 @@ export const isGreaterThanOrEqualTo = Internal.isGreaterThanOrEqualTo;
  * DateTime.isLessThan(date2, date1) // => false
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -852,6 +889,7 @@ export const isLessThan = Internal.isLessThan;
  * DateTime.isLessThanOrEqualTo(date3, date1) // => false
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -871,6 +909,7 @@ export const isLessThanOrEqualTo = Internal.isLessThanOrEqualTo;
  * DateTime.between(date, { minimum: min, maximum: max }) // => true
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -892,6 +931,7 @@ export const between = Internal.between;
  * await Effect.runPromise(Effect.provide(DateTime.isFuture(futureDate), TestClock.layer())) // => true
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -917,6 +957,7 @@ export const isFuture = Internal.isFuture;
  * DateTime.isFutureUnsafe(oneHourFromNow)
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -938,6 +979,7 @@ export const isFutureUnsafe = Internal.isFutureUnsafe;
  * await Effect.runPromise(Effect.provide(DateTime.isPast(pastDate), TestClock.layer())) // => true
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 3.6.0
  */
@@ -963,6 +1005,7 @@ export const isPast = Internal.isPast;
  * DateTime.isPastUnsafe(oneHourAgo)
  * ```
  *
+ * @stability stable
  * @category comparisons
  * @since 4.0.0
  */
@@ -989,6 +1032,7 @@ export const isPastUnsafe = Internal.isPastUnsafe;
  * DateTime.toDateUtc(dt).toISOString() // => "2024-01-01T12:00:00.000Z"
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1015,6 +1059,7 @@ export const toDateUtc = Internal.toDateUtc;
  * DateTime.toDate(zoned).toISOString() // => "2024-01-01T12:00:00.000Z"
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1039,6 +1084,7 @@ export const toDate = Internal.toDate;
  * DateTime.zonedOffset(zoned) // => 0
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1062,6 +1108,7 @@ export const zonedOffset = Internal.zonedOffset;
  * DateTime.zonedOffsetIso(zoned) // => "+03:00"
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1082,6 +1129,7 @@ export const zonedOffsetIso = Internal.zonedOffsetIso;
  * DateTime.toEpochMillis(dt) // => 1704067200000
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1103,6 +1151,7 @@ export const toEpochMillis = Internal.toEpochMillis;
  * DateTime.toEpochSeconds(dt) // => 1704067200
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */
@@ -1126,6 +1175,7 @@ export const toEpochSeconds = Internal.toEpochSeconds;
  * ) // => "2024-01-01T00:00:00.000Z"
  * ```
  *
+ * @stability stable
  * @category converting
  * @since 3.6.0
  */
@@ -1151,6 +1201,7 @@ export const removeTime = Internal.removeTime;
  * const selectedParts = [parts.year, parts.month, parts.day, parts.hour] // => [2024, 1, 1, 12]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.6.0
  */
@@ -1175,6 +1226,7 @@ export const toParts = Internal.toParts;
  * const selectedParts = [parts.year, parts.month, parts.day, parts.hour] // => [2024, 1, 1, 12]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.6.0
  */
@@ -1195,6 +1247,7 @@ export const toPartsUtc = Internal.toPartsUtc;
  * DateTime.getPartUtc(dateTime, "year") // => 2024
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.6.0
  */
@@ -1217,6 +1270,7 @@ export const getPartUtc = Internal.getPartUtc;
  * DateTime.getPart(dateTime, "year") // => 2024
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.6.0
  */
@@ -1243,6 +1297,7 @@ export const getPart = Internal.getPart;
  * updated // => DateTime.makeZonedUnsafe("2025-06-15T12:00:00Z", { timeZone: "UTC" })
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 3.6.0
  */
@@ -1268,6 +1323,7 @@ export const setParts = Internal.setParts;
  * updated // => DateTime.makeUnsafe("2025-01-01T18:00:00Z")
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 3.6.0
  */
@@ -1299,6 +1355,7 @@ export const setPartsUtc = Internal.setPartsUtc;
  * await Effect.runPromise(Effect.provide(program, layer)) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category services
  * @since 3.11.0
  */
@@ -1318,6 +1375,7 @@ export class CurrentTimeZone extends /*#__PURE__*/Context.Service()("effect/Date
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 3.6.0
  */
@@ -1338,6 +1396,7 @@ export const setZoneCurrent = self => Effect.map(CurrentTimeZone, zone => setZon
  * }).pipe(DateTime.withCurrentZone(zone))) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 3.6.0
  */
@@ -1356,6 +1415,7 @@ export const withCurrentZone = /*#__PURE__*/provideService(CurrentTimeZone);
  * }).pipe(DateTime.withCurrentZoneLocal)) // => true
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 3.6.0
  */
@@ -1375,6 +1435,7 @@ export const withCurrentZoneLocal = effect => Effect.provideServiceEffect(effect
  * await Effect.runPromise(program) // => "+03:00"
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 3.6.0
  */
@@ -1398,6 +1459,7 @@ export const withCurrentZoneOffset = /*#__PURE__*/dual(2, (effect, offset) => Ef
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category providing services
  * @since 3.6.0
  */
@@ -1415,6 +1477,7 @@ export const withCurrentZoneNamed = /*#__PURE__*/dual(2, (effect, zone) => Effec
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 3.6.0
  */
@@ -1450,6 +1513,7 @@ export const nowInCurrentZone = /*#__PURE__*/Effect.flatMap(now, setZoneCurrent)
  * })
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1478,6 +1542,7 @@ export const mutate = Internal.mutate;
  * modified // => DateTime.makeZonedUnsafe("2024-01-01T18:00:00Z", { timeZone: "Europe/London" })
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1498,6 +1563,7 @@ export const mutateUtc = Internal.mutateUtc;
  * result // => DateTime.makeUnsafe(10)
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1523,6 +1589,7 @@ export const mapEpochMillis = Internal.mapEpochMillis;
  * ) // => 3600000
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1547,6 +1614,7 @@ export const withDate = Internal.withDate;
  * ) // => 0
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1578,6 +1646,7 @@ export const withDateUtc = Internal.withDateUtc;
  * result2 // => "Zoned: 2024-06-15T15:30:00.000+01:00[Europe/London]"
  * ```
  *
+ * @stability stable
  * @category mapping
  * @since 3.6.0
  */
@@ -1618,6 +1687,7 @@ export const match = Internal.match;
  * @see {@link add} for calendar-aware date/time part arithmetic
  * @see {@link subtractDuration} for subtracting an elapsed duration
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1636,6 +1706,7 @@ export const addDuration = Internal.addDuration;
  * ) // => DateTime.makeUnsafe(-300000)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1659,6 +1730,7 @@ export const subtractDuration = Internal.subtractDuration;
  * ) // => DateTime.makeUnsafe(300000)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1677,6 +1749,7 @@ export const add = Internal.add;
  * ) // => DateTime.makeUnsafe(-300000)
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1700,6 +1773,7 @@ export const subtract = Internal.subtract;
  * ) // => DateTime.makeUnsafe("2024-01-01T00:00:00Z")
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1723,6 +1797,7 @@ export const startOf = Internal.startOf;
  * ) // => DateTime.makeUnsafe("2024-01-01T23:59:59.999Z")
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1746,6 +1821,7 @@ export const endOf = Internal.endOf;
  * ) // => DateTime.makeUnsafe("2024-01-02T00:00:00Z")
  * ```
  *
+ * @stability stable
  * @category math
  * @since 3.6.0
  */
@@ -1781,6 +1857,7 @@ export const nearest = Internal.nearest;
  * }) // => "Saturday, June 15, 2024 at 3:30 PM"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1806,6 +1883,7 @@ export const format = Internal.format;
  * })
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1837,6 +1915,7 @@ export const formatLocal = Internal.formatLocal;
  * })
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1877,6 +1956,7 @@ export const formatUtc = Internal.formatUtc;
  * @see {@link formatUtc} for formatting with options forced to UTC
  * @see {@link formatIso} for stable ISO formatting
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1901,6 +1981,7 @@ export const formatIntl = Internal.formatIntl;
  * DateTime.formatIso(zoned) // => "2024-01-01T12:30:45.123Z"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1926,6 +2007,7 @@ export const formatIso = Internal.formatIso;
  * DateTime.formatIsoDate(zoned) // => "2024-01-02"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1951,6 +2033,7 @@ export const formatIsoDate = Internal.formatIsoDate;
  * DateTime.formatIsoDateUtc(zoned) // => "2024-01-01"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -1977,6 +2060,7 @@ export const formatIsoDateUtc = Internal.formatIsoDateUtc;
  * DateTime.formatIsoOffset(zoned) // => "2024-01-01T15:00:00.000+03:00"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -2006,6 +2090,7 @@ export const formatIsoOffset = Internal.formatIsoOffset;
  * DateTime.formatIsoZoned(offsetZone) // => "2024-06-15T17:30:45.123+03:00"
  * ```
  *
+ * @stability stable
  * @category formatting
  * @since 3.6.0
  */
@@ -2034,6 +2119,7 @@ export const formatIsoZoned = Internal.formatIsoZoned;
  * await Effect.runPromise(Effect.provide(program, layer)) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 3.6.0
  */
@@ -2061,6 +2147,7 @@ export const layerCurrentZone = /*#__PURE__*/Layer.succeed(CurrentTimeZone);
  * await Effect.runPromise(Effect.provide(program, layer)) // => "+03:00"
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 3.6.0
  */
@@ -2088,6 +2175,7 @@ export const layerCurrentZoneOffset = offset => Layer.succeed(CurrentTimeZone)(I
  * await Effect.runPromise(Effect.provide(program, layer)) // => "Europe/London"
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 3.6.0
  */
@@ -2114,6 +2202,7 @@ export const layerCurrentZoneNamed = /*#__PURE__*/flow(Internal.zoneMakeNamedEff
  * await Effect.runPromise(Effect.provide(program, DateTime.layerCurrentZoneLocal)) // => true
  * ```
  *
+ * @stability stable
  * @category layers
  * @since 3.6.0
  */