effect 3.10.18 → 3.10.19

package/src/DateTime.ts

@@ -442,6 +442,7 @@ export const unsafeFromDate = (date: Date): Utc => {
  * @since 3.6.0
  * @category constructors
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // from Date
@@ -452,6 +453,7 @@ export const unsafeFromDate = (date: Date): Utc => {
  *
  * // from string
  * DateTime.unsafeMake("2024-01-01")
+ * ```
  */
 export const unsafeMake = <A extends DateTime.Input>(input: A): DateTime.PreserveZone<A> => {
   if (isDateTime(input)) {
@@ -476,9 +478,11 @@ export const unsafeMake = <A extends DateTime.Input>(input: A): DateTime.Preserv
  * @since 3.6.0
  * @category constructors
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * DateTime.unsafeMakeZoned(new Date(), { timeZone: "Europe/London" })
+ * ```
  */
 export const unsafeMakeZoned = (input: DateTime.Input, options?: {
   readonly timeZone?: number | string | TimeZone | undefined
@@ -519,9 +523,11 @@ export const unsafeMakeZoned = (input: DateTime.Input, options?: {
  * @since 3.6.0
  * @category constructors
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * DateTime.makeZoned(new Date(), { timeZone: "Europe/London" })
+ * ```
  */
 export const makeZoned: (
   input: DateTime.Input,
@@ -545,6 +551,7 @@ export const makeZoned: (
  * @since 3.6.0
  * @category constructors
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // from Date
@@ -555,6 +562,7 @@ export const makeZoned: (
  *
  * // from string
  * DateTime.make("2024-01-01")
+ * ```
  */
 export const make: <A extends DateTime.Input>(input: A) => Option.Option<DateTime.PreserveZone<A>> = Option
   .liftThrowable(unsafeMake)
@@ -585,11 +593,13 @@ export const makeZonedFromString = (input: string): Option.Option<Zoned> => {
  * @since 3.6.0
  * @category constructors
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
  *   const now = yield* DateTime.now
  * })
+ * ```
  */
 export const now: Effect.Effect<Utc> = Effect.map(Clock.currentTimeMillis, makeUtc)
 
@@ -611,6 +621,7 @@ export const unsafeNow: LazyArg<Utc> = () => makeUtc(Date.now())
  * @since 3.6.0
  * @category time zones
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -620,6 +631,7 @@ export const unsafeNow: LazyArg<Utc> = () => makeUtc(Date.now())
  *   // set the time zone
  *   const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
  * })
+ * ```
  */
 export const setZone: {
   // =============================================================================
@@ -632,6 +644,7 @@ export const setZone: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -641,6 +654,7 @@ export const setZone: {
    *   // set the time zone
    *   const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
    * })
+   * ```
    */
   (
     zone: TimeZone,
@@ -658,6 +672,7 @@ export const setZone: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -667,6 +682,7 @@ export const setZone: {
    *   // set the time zone
    *   const zoned: DateTime.Zoned = DateTime.setZone(now, zone)
    * })
+   * ```
    */
   (
     self: DateTime,
@@ -690,6 +706,7 @@ export const setZone: {
  * @since 3.6.0
  * @category time zones
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -698,6 +715,7 @@ export const setZone: {
  *   // set the offset time zone in milliseconds
  *   const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
  * })
+ * ```
  */
 export const setZoneOffset: {
   /**
@@ -708,6 +726,7 @@ export const setZoneOffset: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -716,6 +735,7 @@ export const setZoneOffset: {
    *   // set the offset time zone in milliseconds
    *   const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
    * })
+   * ```
    */
   (
     offset: number,
@@ -731,6 +751,7 @@ export const setZoneOffset: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -739,6 +760,7 @@ export const setZoneOffset: {
    *   // set the offset time zone in milliseconds
    *   const zoned: DateTime.Zoned = DateTime.setZoneOffset(now, 3 * 60 * 60 * 1000)
    * })
+   * ```
    */
   (
     self: DateTime,
@@ -867,6 +889,7 @@ export const zoneFromString = (zone: string): Option.Option<TimeZone> => {
  * @since 3.6.0
  * @category time zones
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * // Outputs "+03:00"
@@ -874,6 +897,7 @@ export const zoneFromString = (zone: string): Option.Option<TimeZone> => {
  *
  * // Outputs "Europe/London"
  * DateTime.zoneToString(DateTime.zoneUnsafeMakeNamed("Europe/London"))
+ * ```
  */
 export const zoneToString = (self: TimeZone): string => {
   if (self._tag === "Offset") {
@@ -889,6 +913,7 @@ export const zoneToString = (self: TimeZone): string => {
  * @since 3.6.0
  * @category time zones
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -896,6 +921,7 @@ export const zoneToString = (self: TimeZone): string => {
  *   // set the time zone, returns an Option
  *   DateTime.setZoneNamed(now, "Europe/London")
  * })
+ * ```
  */
 export const setZoneNamed: {
   /**
@@ -905,6 +931,7 @@ export const setZoneNamed: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -912,6 +939,7 @@ export const setZoneNamed: {
    *   // set the time zone, returns an Option
    *   DateTime.setZoneNamed(now, "Europe/London")
    * })
+   * ```
    */
   (
     zoneId: string,
@@ -926,6 +954,7 @@ export const setZoneNamed: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -933,6 +962,7 @@ export const setZoneNamed: {
    *   // set the time zone, returns an Option
    *   DateTime.setZoneNamed(now, "Europe/London")
    * })
+   * ```
    */
   (
     self: DateTime,
@@ -955,6 +985,7 @@ export const setZoneNamed: {
  * @since 3.6.0
  * @category time zones
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -962,6 +993,7 @@ export const setZoneNamed: {
  *   // set the time zone
  *   DateTime.unsafeSetZoneNamed(now, "Europe/London")
  * })
+ * ```
  */
 export const unsafeSetZoneNamed: {
   /**
@@ -971,6 +1003,7 @@ export const unsafeSetZoneNamed: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -978,6 +1011,7 @@ export const unsafeSetZoneNamed: {
    *   // set the time zone
    *   DateTime.unsafeSetZoneNamed(now, "Europe/London")
    * })
+   * ```
    */
   (
     zoneId: string,
@@ -992,6 +1026,7 @@ export const unsafeSetZoneNamed: {
    * @since 3.6.0
    * @category time zones
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -999,6 +1034,7 @@ export const unsafeSetZoneNamed: {
    *   // set the time zone
    *   DateTime.unsafeSetZoneNamed(now, "Europe/London")
    * })
+   * ```
    */
   (
     self: DateTime,
@@ -1024,6 +1060,7 @@ export const unsafeSetZoneNamed: {
  * @since 3.6.0
  * @category comparisons
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -1033,6 +1070,7 @@ export const unsafeSetZoneNamed: {
  *   // returns 60000
  *   DateTime.distance(now, other)
  * })
+ * ```
  */
 export const distance: {
   // =============================================================================
@@ -1048,6 +1086,7 @@ export const distance: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1057,6 +1096,7 @@ export const distance: {
    *   // returns 60000
    *   DateTime.distance(now, other)
    * })
+   * ```
    */
   (other: DateTime): (self: DateTime) => number
   // =============================================================================
@@ -1072,6 +1112,7 @@ export const distance: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1081,6 +1122,7 @@ export const distance: {
    *   // returns 60000
    *   DateTime.distance(now, other)
    * })
+   * ```
    */
   (self: DateTime, other: DateTime): number
 } = dual(2, (self: DateTime, other: DateTime): number => toEpochMillis(other) - toEpochMillis(self))
@@ -1097,6 +1139,7 @@ export const distance: {
  * @since 3.6.0
  * @category comparisons
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -1109,6 +1152,7 @@ export const distance: {
  *   // returns Either.left(Duration.minutes(1))
  *   DateTime.distanceDurationEither(other, now)
  * })
+ * ```
  */
 export const distanceDurationEither: {
   /**
@@ -1123,6 +1167,7 @@ export const distanceDurationEither: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1135,6 +1180,7 @@ export const distanceDurationEither: {
    *   // returns Either.left(Duration.minutes(1))
    *   DateTime.distanceDurationEither(other, now)
    * })
+   * ```
    */
   (other: DateTime): (self: DateTime) => Either.Either<Duration.Duration, Duration.Duration>
   /**
@@ -1149,6 +1195,7 @@ export const distanceDurationEither: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1161,6 +1208,7 @@ export const distanceDurationEither: {
    *   // returns Either.left(Duration.minutes(1))
    *   DateTime.distanceDurationEither(other, now)
    * })
+   * ```
    */
   (self: DateTime, other: DateTime): Either.Either<Duration.Duration, Duration.Duration>
 } = dual(2, (self: DateTime, other: DateTime): Either.Either<Duration.Duration, Duration.Duration> => {
@@ -1176,6 +1224,7 @@ export const distanceDurationEither: {
  * @since 3.6.0
  * @category comparisons
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -1185,6 +1234,7 @@ export const distanceDurationEither: {
  *   // returns Duration.minutes(1)
  *   DateTime.distanceDuration(now, other)
  * })
+ * ```
  */
 export const distanceDuration: {
   /**
@@ -1193,6 +1243,7 @@ export const distanceDuration: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1202,6 +1253,7 @@ export const distanceDuration: {
    *   // returns Duration.minutes(1)
    *   DateTime.distanceDuration(now, other)
    * })
+   * ```
    */
   (other: DateTime): (self: DateTime) => Duration.Duration
   /**
@@ -1210,6 +1262,7 @@ export const distanceDuration: {
    * @since 3.6.0
    * @category comparisons
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
@@ -1219,6 +1272,7 @@ export const distanceDuration: {
    *   // returns Duration.minutes(1)
    *   DateTime.distanceDuration(now, other)
    * })
+   * ```
    */
   (self: DateTime, other: DateTime): Duration.Duration
 } = dual(
@@ -1455,6 +1509,7 @@ export const toEpochMillis = (self: DateTime): number => self.epochMillis
  * @since 3.6.0
  * @category conversions
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // returns "2024-01-01T00:00:00Z"
@@ -1465,6 +1520,7 @@ export const toEpochMillis = (self: DateTime): number => self.epochMillis
  *   DateTime.removeTime,
  *   DateTime.formatIso
  * )
+ * ```
  */
 export const removeTime = (self: DateTime): Utc =>
   withDate(self, (date) => {
@@ -1529,11 +1585,13 @@ export const toPartsUtc = (self: DateTime): DateTime.PartsWithWeekday => {
  * @since 3.6.0
  * @category parts
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * const now = DateTime.unsafeMake({ year: 2024 })
  * const year = DateTime.getPartUtc(now, "year")
  * assert.strictEqual(year, 2024)
+ * ```
  */
 export const getPartUtc: {
   /**
@@ -1544,11 +1602,13 @@ export const getPartUtc: {
    * @since 3.6.0
    * @category parts
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMake({ year: 2024 })
    * const year = DateTime.getPartUtc(now, "year")
    * assert.strictEqual(year, 2024)
+   * ```
    */
   (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number
   /**
@@ -1559,11 +1619,13 @@ export const getPartUtc: {
    * @since 3.6.0
    * @category parts
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMake({ year: 2024 })
    * const year = DateTime.getPartUtc(now, "year")
    * assert.strictEqual(year, 2024)
+   * ```
    */
   (self: DateTime, part: keyof DateTime.PartsWithWeekday): number
 } = dual(2, (self: DateTime, part: keyof DateTime.PartsWithWeekday): number => toPartsUtc(self)[part])
@@ -1576,11 +1638,13 @@ export const getPartUtc: {
  * @since 3.6.0
  * @category parts
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })
  * const year = DateTime.getPart(now, "year")
  * assert.strictEqual(year, 2024)
+ * ```
  */
 export const getPart: {
   /**
@@ -1591,11 +1655,13 @@ export const getPart: {
    * @since 3.6.0
    * @category parts
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })
    * const year = DateTime.getPart(now, "year")
    * assert.strictEqual(year, 2024)
+   * ```
    */
   (part: keyof DateTime.PartsWithWeekday): (self: DateTime) => number
   /**
@@ -1606,11 +1672,13 @@ export const getPart: {
    * @since 3.6.0
    * @category parts
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * const now = DateTime.unsafeMakeZoned({ year: 2024 }, { timeZone: "Europe/London" })
    * const year = DateTime.getPart(now, "year")
    * assert.strictEqual(year, 2024)
+   * ```
    */
   (self: DateTime, part: keyof DateTime.PartsWithWeekday): number
 } = dual(2, (self: DateTime, part: keyof DateTime.PartsWithWeekday): number => toParts(self)[part])
@@ -1723,6 +1791,7 @@ export class CurrentTimeZone extends Context.Tag("effect/DateTime/CurrentTimeZon
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
@@ -1731,6 +1800,7 @@ export class CurrentTimeZone extends Context.Tag("effect/DateTime/CurrentTimeZon
  *   // set the time zone to "Europe/London"
  *   const zoned = yield* DateTime.setZoneCurrent(now)
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
+ * ```
  */
 export const setZoneCurrent = (self: DateTime): Effect.Effect<Zoned, never, CurrentTimeZone> =>
   Effect.map(CurrentTimeZone, (zone) => setZone(self, zone))
@@ -1741,6 +1811,7 @@ export const setZoneCurrent = (self: DateTime): Effect.Effect<Zoned, never, Curr
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * const zone = DateTime.zoneUnsafeMakeNamed("Europe/London")
@@ -1748,6 +1819,7 @@ export const setZoneCurrent = (self: DateTime): Effect.Effect<Zoned, never, Curr
  * Effect.gen(function* () {
  *   const now = yield* DateTime.nowInCurrentZone
  * }).pipe(DateTime.withCurrentZone(zone))
+ * ```
  */
 export const withCurrentZone: {
   /**
@@ -1756,6 +1828,7 @@ export const withCurrentZone: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * const zone = DateTime.zoneUnsafeMakeNamed("Europe/London")
@@ -1763,6 +1836,7 @@ export const withCurrentZone: {
    * Effect.gen(function* () {
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZone(zone))
+   * ```
    */
   (zone: TimeZone): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>
   /**
@@ -1771,6 +1845,7 @@ export const withCurrentZone: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * const zone = DateTime.zoneUnsafeMakeNamed("Europe/London")
@@ -1778,6 +1853,7 @@ export const withCurrentZone: {
    * Effect.gen(function* () {
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZone(zone))
+   * ```
    */
   <A, E, R>(effect: Effect.Effect<A, E, R>, zone: TimeZone): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>
 } = dual(
@@ -1793,12 +1869,14 @@ export const withCurrentZone: {
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
  *   // will use the system's local time zone
  *   const now = yield* DateTime.nowInCurrentZone
  * }).pipe(DateTime.withCurrentZoneLocal)
+ * ```
  */
 export const withCurrentZoneLocal = <A, E, R>(
   effect: Effect.Effect<A, E, R>
@@ -1811,12 +1889,14 @@ export const withCurrentZoneLocal = <A, E, R>(
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
  *   // will use the system's local time zone
  *   const now = yield* DateTime.nowInCurrentZone
  * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
+ * ```
  */
 export const withCurrentZoneOffset: {
   /**
@@ -1825,12 +1905,14 @@ export const withCurrentZoneOffset: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
    *   // will use the system's local time zone
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
+   * ```
    */
   (offset: number): <A, E, R>(
     effect: Effect.Effect<A, E, R>
@@ -1841,12 +1923,14 @@ export const withCurrentZoneOffset: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
    *   // will use the system's local time zone
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZoneOffset(3 * 60 * 60 * 1000))
+   * ```
    */
   <A, E, R>(effect: Effect.Effect<A, E, R>, offset: number): Effect.Effect<A, E, Exclude<R, CurrentTimeZone>>
 } = dual(
@@ -1864,12 +1948,14 @@ export const withCurrentZoneOffset: {
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
  *   // will use the "Europe/London" time zone
  *   const now = yield* DateTime.nowInCurrentZone
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
+ * ```
  */
 export const withCurrentZoneNamed: {
   /**
@@ -1881,12 +1967,14 @@ export const withCurrentZoneNamed: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
    *   // will use the "Europe/London" time zone
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
+   * ```
    */
   (zone: string): <A, E, R>(
     effect: Effect.Effect<A, E, R>
@@ -1900,12 +1988,14 @@ export const withCurrentZoneNamed: {
    * @since 3.6.0
    * @category current time zone
    * @example
+   * ```ts
    * import { DateTime, Effect } from "effect"
    *
    * Effect.gen(function* () {
    *   // will use the "Europe/London" time zone
    *   const now = yield* DateTime.nowInCurrentZone
    * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
+   * ```
    */
   <A, E, R>(
     effect: Effect.Effect<A, E, R>,
@@ -1926,12 +2016,14 @@ export const withCurrentZoneNamed: {
  * @since 3.6.0
  * @category current time zone
  * @example
+ * ```ts
  * import { DateTime, Effect } from "effect"
  *
  * Effect.gen(function* () {
  *   // will use the "Europe/London" time zone
  *   const now = yield* DateTime.nowInCurrentZone
  * }).pipe(DateTime.withCurrentZoneNamed("Europe/London"))
+ * ```
  */
 export const nowInCurrentZone: Effect.Effect<Zoned, never, CurrentTimeZone> = Effect.flatMap(
   now,
@@ -2084,12 +2176,14 @@ export const mutateUtc: {
  * @since 3.6.0
  * @category mapping
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // add 10 milliseconds
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.mapEpochMillis((millis) => millis + 10)
  * )
+ * ```
  */
 export const mapEpochMillis: {
   /**
@@ -2099,12 +2193,14 @@ export const mapEpochMillis: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 10 milliseconds
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.mapEpochMillis((millis) => millis + 10)
    * )
+   * ```
    */
   (f: (millis: number) => number): <A extends DateTime>(self: A) => DateTime.PreserveZone<A>
   /**
@@ -2114,12 +2210,14 @@ export const mapEpochMillis: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 10 milliseconds
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.mapEpochMillis((millis) => millis + 10)
    * )
+   * ```
    */
   <A extends DateTime>(self: A, f: (millis: number) => number): DateTime.PreserveZone<A>
 } = dual(2, (self: DateTime, f: (millis: number) => number): DateTime => {
@@ -2134,12 +2232,14 @@ export const mapEpochMillis: {
  * @since 3.6.0
  * @category mapping
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // get the time zone adjusted date in milliseconds
  * DateTime.unsafeMakeZoned(0, { timeZone: "Europe/London" }).pipe(
  *   DateTime.withDate((date) => date.getTime())
  * )
+ * ```
  */
 export const withDate: {
   /**
@@ -2149,12 +2249,14 @@ export const withDate: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // get the time zone adjusted date in milliseconds
    * DateTime.unsafeMakeZoned(0, { timeZone: "Europe/London" }).pipe(
    *   DateTime.withDate((date) => date.getTime())
    * )
+   * ```
    */
   <A>(f: (date: Date) => A): (self: DateTime) => A
   /**
@@ -2164,12 +2266,14 @@ export const withDate: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // get the time zone adjusted date in milliseconds
    * DateTime.unsafeMakeZoned(0, { timeZone: "Europe/London" }).pipe(
    *   DateTime.withDate((date) => date.getTime())
    * )
+   * ```
    */
   <A>(self: DateTime, f: (date: Date) => A): A
 } = dual(2, <A>(self: DateTime, f: (date: Date) => A): A => f(toDate(self)))
@@ -2181,12 +2285,14 @@ export const withDate: {
  * @since 3.6.0
  * @category mapping
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // get the date in milliseconds
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.withDateUtc((date) => date.getTime())
  * )
+ * ```
  */
 export const withDateUtc: {
   /**
@@ -2196,12 +2302,14 @@ export const withDateUtc: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // get the date in milliseconds
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.withDateUtc((date) => date.getTime())
    * )
+   * ```
    */
   <A>(f: (date: Date) => A): (self: DateTime) => A
   /**
@@ -2211,12 +2319,14 @@ export const withDateUtc: {
    * @since 3.6.0
    * @category mapping
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // get the date in milliseconds
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.withDateUtc((date) => date.getTime())
    * )
+   * ```
    */
   <A>(self: DateTime, f: (date: Date) => A): A
 } = dual(2, <A>(self: DateTime, f: (date: Date) => A): A => f(toDateUtc(self)))
@@ -2262,12 +2372,14 @@ export const match: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // add 5 minutes
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.addDuration("5 minutes")
  * )
+ * ```
  */
 export const addDuration: {
   // =============================================================================
@@ -2280,12 +2392,14 @@ export const addDuration: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.addDuration("5 minutes")
    * )
+   * ```
    */
   (duration: Duration.DurationInput): <A extends DateTime>(self: A) => DateTime.PreserveZone<A>
   // =============================================================================
@@ -2298,12 +2412,14 @@ export const addDuration: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.addDuration("5 minutes")
    * )
+   * ```
    */
   <A extends DateTime>(self: A, duration: Duration.DurationInput): DateTime.PreserveZone<A>
 } = dual(
@@ -2318,12 +2434,14 @@ export const addDuration: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // subtract 5 minutes
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.subtractDuration("5 minutes")
  * )
+ * ```
  */
 export const subtractDuration: {
   /**
@@ -2332,12 +2450,14 @@ export const subtractDuration: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // subtract 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.subtractDuration("5 minutes")
    * )
+   * ```
    */
   (duration: Duration.DurationInput): <A extends DateTime>(self: A) => DateTime.PreserveZone<A>
   /**
@@ -2346,12 +2466,14 @@ export const subtractDuration: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // subtract 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.subtractDuration("5 minutes")
    * )
+   * ```
    */
   <A extends DateTime>(self: A, duration: Duration.DurationInput): DateTime.PreserveZone<A>
 } = dual(
@@ -2373,12 +2495,14 @@ const addMillis = (date: Date, amount: number): void => {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // add 5 minutes
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.add({ minutes: 5 })
  * )
+ * ```
  */
 export const add: {
   /**
@@ -2390,12 +2514,14 @@ export const add: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.add({ minutes: 5 })
    * )
+   * ```
    */
   (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => DateTime.PreserveZone<A>
   /**
@@ -2407,12 +2533,14 @@ export const add: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // add 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.add({ minutes: 5 })
    * )
+   * ```
    */
   <A extends DateTime>(self: A, parts: Partial<DateTime.PartsForMath>): DateTime.PreserveZone<A>
 } = dual(2, (self: DateTime, parts: Partial<DateTime.PartsForMath>): DateTime =>
@@ -2462,12 +2590,14 @@ export const add: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // subtract 5 minutes
  * DateTime.unsafeMake(0).pipe(
  *   DateTime.subtract({ minutes: 5 })
  * )
+ * ```
  */
 export const subtract: {
   /**
@@ -2476,12 +2606,14 @@ export const subtract: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // subtract 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.subtract({ minutes: 5 })
    * )
+   * ```
    */
   (parts: Partial<DateTime.PartsForMath>): <A extends DateTime>(self: A) => DateTime.PreserveZone<A>
   /**
@@ -2490,12 +2622,14 @@ export const subtract: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // subtract 5 minutes
    * DateTime.unsafeMake(0).pipe(
    *   DateTime.subtract({ minutes: 5 })
    * )
+   * ```
    */
   <A extends DateTime>(self: A, parts: Partial<DateTime.PartsForMath>): DateTime.PreserveZone<A>
 } = dual(2, (self: DateTime, parts: Partial<DateTime.PartsForMath>): DateTime => {
@@ -2556,6 +2690,7 @@ function startOfDate(date: Date, part: DateTime.UnitSingular, options?: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // returns "2024-01-01T00:00:00Z"
@@ -2563,6 +2698,7 @@ function startOfDate(date: Date, part: DateTime.UnitSingular, options?: {
  *   DateTime.startOf("day"),
  *   DateTime.formatIso
  * )
+ * ```
  */
 export const startOf: {
   /**
@@ -2574,6 +2710,7 @@ export const startOf: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-01T00:00:00Z"
@@ -2581,6 +2718,7 @@ export const startOf: {
    *   DateTime.startOf("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   (
     part: DateTime.UnitSingular,
@@ -2597,6 +2735,7 @@ export const startOf: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-01T00:00:00Z"
@@ -2604,6 +2743,7 @@ export const startOf: {
    *   DateTime.startOf("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   <A extends DateTime>(
     self: A,
@@ -2666,6 +2806,7 @@ function endOfDate(date: Date, part: DateTime.UnitSingular, options?: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // returns "2024-01-01T23:59:59.999Z"
@@ -2673,6 +2814,7 @@ function endOfDate(date: Date, part: DateTime.UnitSingular, options?: {
  *   DateTime.endOf("day"),
  *   DateTime.formatIso
  * )
+ * ```
  */
 export const endOf: {
   /**
@@ -2684,6 +2826,7 @@ export const endOf: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-01T23:59:59.999Z"
@@ -2691,6 +2834,7 @@ export const endOf: {
    *   DateTime.endOf("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   (
     part: DateTime.UnitSingular,
@@ -2707,6 +2851,7 @@ export const endOf: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-01T23:59:59.999Z"
@@ -2714,6 +2859,7 @@ export const endOf: {
    *   DateTime.endOf("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   <A extends DateTime>(
     self: A,
@@ -2735,6 +2881,7 @@ export const endOf: {
  * @since 3.6.0
  * @category math
  * @example
+ * ```ts
  * import { DateTime } from "effect"
  *
  * // returns "2024-01-02T00:00:00Z"
@@ -2742,6 +2889,7 @@ export const endOf: {
  *   DateTime.nearest("day"),
  *   DateTime.formatIso
  * )
+ * ```
  */
 export const nearest: {
   /**
@@ -2753,6 +2901,7 @@ export const nearest: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-02T00:00:00Z"
@@ -2760,6 +2909,7 @@ export const nearest: {
    *   DateTime.nearest("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   (
     part: DateTime.UnitSingular,
@@ -2776,6 +2926,7 @@ export const nearest: {
    * @since 3.6.0
    * @category math
    * @example
+   * ```ts
    * import { DateTime } from "effect"
    *
    * // returns "2024-01-02T00:00:00Z"
@@ -2783,6 +2934,7 @@ export const nearest: {
    *   DateTime.nearest("day"),
    *   DateTime.formatIso
    * )
+   * ```
    */
   <A extends DateTime>(
     self: A,