effect 4.0.0-beta.71 → 4.0.0-beta.73

package/dist/Deferred.d.ts

@@ -165,7 +165,7 @@ export declare namespace Deferred {
     }
 }
 /**
- * Synchronously creates an empty `Deferred` outside the `Effect` runtime.
+ * Creates an empty `Deferred` synchronously outside the `Effect` runtime.
  *
  * **When to use**
  *
@@ -473,7 +473,7 @@ export declare const completeWith: {
     <A, E>(self: Deferred<A, E>, effect: Effect<A, E>): Effect<boolean>;
 };
 /**
- * Exits the `Deferred` with the specified `Exit` value, which will be
+ * Completes the `Deferred` with the specified `Exit` value, which will be
  * propagated to all fibers waiting on the value of the `Deferred`.
  *
  * **When to use**
@@ -509,7 +509,7 @@ export declare const completeWith: {
  */
 export declare const done: {
     /**
-     * Exits the `Deferred` with the specified `Exit` value, which will be
+     * Completes the `Deferred` with the specified `Exit` value, which will be
      * propagated to all fibers waiting on the value of the `Deferred`.
      *
      * **When to use**
@@ -545,7 +545,7 @@ export declare const done: {
      */
     <A, E>(exit: Exit.Exit<A, E>): (self: Deferred<A, E>) => Effect<boolean>;
     /**
-     * Exits the `Deferred` with the specified `Exit` value, which will be
+     * Completes the `Deferred` with the specified `Exit` value, which will be
      * propagated to all fibers waiting on the value of the `Deferred`.
      *
      * **When to use**
@@ -1304,7 +1304,7 @@ export declare const interruptWith: {
  */
 export declare const isDone: <A, E>(self: Deferred<A, E>) => Effect<boolean>;
 /**
- * Synchronously returns whether this `Deferred` has already been completed.
+ * Returns whether this `Deferred` has already been completed synchronously.
  *
  * **When to use**
  *
@@ -1540,7 +1540,7 @@ export declare const sync: {
     <A, E>(self: Deferred<A, E>, evaluate: LazyArg<A>): Effect<boolean>;
 };
 /**
- * Synchronously attempts to complete the `Deferred` with the specified
+ * Attempts to complete the `Deferred` synchronously with the specified
  * completion effect.
  *
  * **When to use**

package/dist/Deferred.js

@@ -27,7 +27,7 @@ const DeferredProto = {
   }
 };
 /**
- * Synchronously creates an empty `Deferred` outside the `Effect` runtime.
+ * Creates an empty `Deferred` synchronously outside the `Effect` runtime.
  *
  * **When to use**
  *
@@ -196,7 +196,7 @@ export const complete = /*#__PURE__*/dual(2, (self, effect) => internalEffect.su
  */
 export const completeWith = /*#__PURE__*/dual(2, (self, effect) => internalEffect.sync(() => doneUnsafe(self, effect)));
 /**
- * Exits the `Deferred` with the specified `Exit` value, which will be
+ * Completes the `Deferred` with the specified `Exit` value, which will be
  * propagated to all fibers waiting on the value of the `Deferred`.
  *
  * **When to use**
@@ -509,7 +509,7 @@ export const interruptWith = /*#__PURE__*/dual(2, (self, fiberId) => failCause(s
  */
 export const isDone = self => internalEffect.sync(() => isDoneUnsafe(self));
 /**
- * Synchronously returns whether this `Deferred` has already been completed.
+ * Returns whether this `Deferred` has already been completed synchronously.
  *
  * **When to use**
  *
@@ -619,7 +619,7 @@ export const succeed = /*#__PURE__*/dual(2, (self, value) => done(self, core.exi
  */
 export const sync = /*#__PURE__*/dual(2, (self, evaluate) => internalEffect.suspend(() => succeed(self, evaluate())));
 /**
- * Synchronously attempts to complete the `Deferred` with the specified
+ * Attempts to complete the `Deferred` synchronously with the specified
  * completion effect.
  *
  * **When to use**

package/dist/Duration.d.ts

@@ -203,7 +203,7 @@ export interface DurationObject {
  */
 export declare const fromInputUnsafe: (input: Input) => Duration;
 /**
- * Safely decodes a `Input` value into a `Duration`, returning
+ * Decodes a `Input` value into a `Duration` safely, returning
  * `Option.none()` if decoding fails.
  *
  * **Example** (Safely decoding duration inputs)
@@ -221,7 +221,7 @@ export declare const fromInputUnsafe: (input: Input) => Duration;
  */
 export declare const fromInput: (u: Input) => Option.Option<Duration>;
 /**
- * Checks if a value is a Duration.
+ * Checks whether a value is a Duration.
  *
  * **Example** (Checking for durations)
  *
@@ -237,7 +237,7 @@ export declare const fromInput: (u: Input) => Option.Option<Duration>;
  */
 export declare const isDuration: (u: unknown) => u is Duration;
 /**
- * Checks if a Duration is finite (not infinite).
+ * Checks whether a Duration is finite (not infinite).
  *
  * **Example** (Checking finite durations)
  *
@@ -253,7 +253,7 @@ export declare const isDuration: (u: unknown) => u is Duration;
  */
 export declare const isFinite: (self: Duration) => boolean;
 /**
- * Checks if a Duration is zero.
+ * Checks whether a Duration is zero.
  *
  * **Example** (Checking for zero durations)
  *
@@ -319,7 +319,7 @@ export declare const isPositive: (self: Duration) => boolean;
  */
 export declare const abs: (self: Duration) => Duration;
 /**
- * Negates the duration.
+ * Returns the negated duration.
  *
  * **Example** (Negating durations)
  *
@@ -604,7 +604,7 @@ export declare const toDays: (self: Input) => number;
  */
 export declare const toWeeks: (self: Input) => number;
 /**
- * Get the duration in nanoseconds as a bigint.
+ * Gets the duration in nanoseconds as a bigint, throwing for infinite durations.
  *
  * **Gotchas**
  *
@@ -628,7 +628,7 @@ export declare const toWeeks: (self: Input) => number;
  */
 export declare const toNanosUnsafe: (input: Input) => bigint;
 /**
- * Get the duration in nanoseconds as a bigint.
+ * Gets the duration in nanoseconds safely as an `Option<bigint>`.
  *
  * **Details**
  *
@@ -825,7 +825,7 @@ export declare const matchPair: {
     }): A | B | C;
 };
 /**
- * Order instance for `Duration`, allowing comparison operations.
+ * Provides an `Order` instance for comparing `Duration` values.
  *
  * **Details**
  *
@@ -968,7 +968,7 @@ export declare const between: {
     }): boolean;
 };
 /**
- * Equivalence instance for `Duration`, allowing equality comparisons.
+ * Provides an `Equivalence` instance for comparing `Duration` values.
  *
  * **Example** (Comparing durations for equivalence)
  *
@@ -995,7 +995,7 @@ export declare const Equivalence: Equ.Equivalence<Duration>;
  * console.log(Duration.toSeconds(shorter)) // 3
  * ```
  *
- * @category order
+ * @category ordering
  * @since 2.0.0
  */
 export declare const min: {
@@ -1011,7 +1011,7 @@ export declare const min: {
      * console.log(Duration.toSeconds(shorter)) // 3
      * ```
      *
-     * @category order
+     * @category ordering
      * @since 2.0.0
      */
     (that: Duration): (self: Duration) => Duration;
@@ -1027,7 +1027,7 @@ export declare const min: {
      * console.log(Duration.toSeconds(shorter)) // 3
      * ```
      *
-     * @category order
+     * @category ordering
      * @since 2.0.0
      */
     (self: Duration, that: Duration): Duration;
@@ -1082,7 +1082,7 @@ export declare const max: {
     (self: Duration, that: Duration): Duration;
 };
 /**
- * Clamps a Duration between a minimum and maximum value.
+ * Returns a `Duration` constrained between a minimum and maximum value.
  *
  * **Example** (Clamping durations to a range)
  *
@@ -1101,7 +1101,7 @@ export declare const max: {
  */
 export declare const clamp: {
     /**
-     * Clamps a Duration between a minimum and maximum value.
+     * Returns a `Duration` constrained between a minimum and maximum value.
      *
      * **Example** (Clamping durations to a range)
      *
@@ -1123,7 +1123,7 @@ export declare const clamp: {
         maximum: Duration;
     }): (self: Duration) => Duration;
     /**
-     * Clamps a Duration between a minimum and maximum value.
+     * Returns a `Duration` constrained between a minimum and maximum value.
      *
      * **Example** (Clamping durations to a range)
      *
@@ -1146,7 +1146,7 @@ export declare const clamp: {
     }): Duration;
 };
 /**
- * Safely divides a `Duration` by a finite, non-zero number.
+ * Divides a `Duration` by a finite, non-zero number safely.
  *
  * **Details**
  *
@@ -1170,7 +1170,7 @@ export declare const clamp: {
  */
 export declare const divide: {
     /**
-     * Safely divides a `Duration` by a finite, non-zero number.
+     * Divides a `Duration` by a finite, non-zero number safely.
      *
      * **Details**
      *
@@ -1194,7 +1194,7 @@ export declare const divide: {
      */
     (by: number): (self: Duration) => Option.Option<Duration>;
     /**
-     * Safely divides a `Duration` by a finite, non-zero number.
+     * Divides a `Duration` by a finite, non-zero number safely.
      *
      * **Details**
      *
@@ -1304,7 +1304,7 @@ export declare const divideUnsafe: {
     (self: Duration, by: number): Duration;
 };
 /**
- * Multiplies a `Duration` by a number.
+ * Returns a `Duration` multiplied by a number.
  *
  * **Details**
  *
@@ -1327,7 +1327,7 @@ export declare const divideUnsafe: {
  */
 export declare const times: {
     /**
-     * Multiplies a `Duration` by a number.
+     * Returns a `Duration` multiplied by a number.
      *
      * **Details**
      *
@@ -1350,7 +1350,7 @@ export declare const times: {
      */
     (times: number): (self: Duration) => Duration;
     /**
-     * Multiplies a `Duration` by a number.
+     * Returns a `Duration` multiplied by a number.
      *
      * **Details**
      *
@@ -1541,7 +1541,7 @@ export declare const sum: {
     (self: Duration, that: Duration): Duration;
 };
 /**
- * Checks if the first Duration is less than the second.
+ * Checks whether the first Duration is less than the second.
  *
  * **Example** (Comparing durations with less than)
  *
@@ -1557,7 +1557,7 @@ export declare const sum: {
  */
 export declare const isLessThan: {
     /**
-     * Checks if the first Duration is less than the second.
+     * Checks whether the first Duration is less than the second.
      *
      * **Example** (Comparing durations with less than)
      *
@@ -1573,7 +1573,7 @@ export declare const isLessThan: {
      */
     (that: Duration): (self: Duration) => boolean;
     /**
-     * Checks if the first Duration is less than the second.
+     * Checks whether the first Duration is less than the second.
      *
      * **Example** (Comparing durations with less than)
      *
@@ -1590,7 +1590,7 @@ export declare const isLessThan: {
     (self: Duration, that: Duration): boolean;
 };
 /**
- * Checks if the first Duration is less than or equal to the second.
+ * Checks whether the first Duration is less than or equal to the second.
  *
  * **Example** (Comparing durations with less than or equal)
  *
@@ -1609,7 +1609,7 @@ export declare const isLessThan: {
  */
 export declare const isLessThanOrEqualTo: {
     /**
-     * Checks if the first Duration is less than or equal to the second.
+     * Checks whether the first Duration is less than or equal to the second.
      *
      * **Example** (Comparing durations with less than or equal)
      *
@@ -1628,7 +1628,7 @@ export declare const isLessThanOrEqualTo: {
      */
     (that: Duration): (self: Duration) => boolean;
     /**
-     * Checks if the first Duration is less than or equal to the second.
+     * Checks whether the first Duration is less than or equal to the second.
      *
      * **Example** (Comparing durations with less than or equal)
      *
@@ -1648,7 +1648,7 @@ export declare const isLessThanOrEqualTo: {
     (self: Duration, that: Duration): boolean;
 };
 /**
- * Checks if the first Duration is greater than the second.
+ * Checks whether the first Duration is greater than the second.
  *
  * **Example** (Comparing durations with greater than)
  *
@@ -1664,7 +1664,7 @@ export declare const isLessThanOrEqualTo: {
  */
 export declare const isGreaterThan: {
     /**
-     * Checks if the first Duration is greater than the second.
+     * Checks whether the first Duration is greater than the second.
      *
      * **Example** (Comparing durations with greater than)
      *
@@ -1680,7 +1680,7 @@ export declare const isGreaterThan: {
      */
     (that: Duration): (self: Duration) => boolean;
     /**
-     * Checks if the first Duration is greater than the second.
+     * Checks whether the first Duration is greater than the second.
      *
      * **Example** (Comparing durations with greater than)
      *
@@ -1697,7 +1697,7 @@ export declare const isGreaterThan: {
     (self: Duration, that: Duration): boolean;
 };
 /**
- * Checks if the first Duration is greater than or equal to the second.
+ * Checks whether the first Duration is greater than or equal to the second.
  *
  * **Example** (Comparing durations with greater than or equal)
  *
@@ -1716,7 +1716,7 @@ export declare const isGreaterThan: {
  */
 export declare const isGreaterThanOrEqualTo: {
     /**
-     * Checks if the first Duration is greater than or equal to the second.
+     * Checks whether the first Duration is greater than or equal to the second.
      *
      * **Example** (Comparing durations with greater than or equal)
      *
@@ -1735,7 +1735,7 @@ export declare const isGreaterThanOrEqualTo: {
      */
     (that: Duration): (self: Duration) => boolean;
     /**
-     * Checks if the first Duration is greater than or equal to the second.
+     * Checks whether the first Duration is greater than or equal to the second.
      *
      * **Example** (Comparing durations with greater than or equal)
      *
@@ -1755,7 +1755,7 @@ export declare const isGreaterThanOrEqualTo: {
     (self: Duration, that: Duration): boolean;
 };
 /**
- * Checks if two Durations are equal.
+ * Checks whether two Durations are equal.
  *
  * **Example** (Checking duration equality)
  *
@@ -1771,7 +1771,7 @@ export declare const isGreaterThanOrEqualTo: {
  */
 export declare const equals: {
     /**
-     * Checks if two Durations are equal.
+     * Checks whether two Durations are equal.
      *
      * **Example** (Checking duration equality)
      *
@@ -1787,7 +1787,7 @@ export declare const equals: {
      */
     (that: Duration): (self: Duration) => boolean;
     /**
-     * Checks if two Durations are equal.
+     * Checks whether two Durations are equal.
      *
      * **Example** (Checking duration equality)
      *
@@ -1877,7 +1877,7 @@ export declare const parts: (self: Duration) => {
  */
 export declare const format: (self: Duration) => string;
 /**
- * A `Reducer` for summing `Duration`s.
+ * Reducer for summing `Duration`s.
  *
  * **When to use**
  *
@@ -1897,7 +1897,7 @@ export declare const format: (self: Duration) => string;
  */
 export declare const ReducerSum: Reducer.Reducer<Duration>;
 /**
- * A `Combiner` that returns the maximum `Duration`.
+ * Combiner that returns the maximum `Duration`.
  *
  * **When to use**
  *
@@ -1911,7 +1911,7 @@ export declare const ReducerSum: Reducer.Reducer<Duration>;
  */
 export declare const CombinerMax: Combiner.Combiner<Duration>;
 /**
- * A `Combiner` that returns the minimum `Duration`.
+ * Combiner that returns the minimum `Duration`.
  *
  * **When to use**
  *

package/dist/Duration.js

@@ -175,7 +175,7 @@ const invalid = input => {
   throw new Error(`Invalid Input: ${input}`);
 };
 /**
- * Safely decodes a `Input` value into a `Duration`, returning
+ * Decodes a `Input` value into a `Duration` safely, returning
  * `Option.none()` if decoding fails.
  *
  * **Example** (Safely decoding duration inputs)
@@ -284,7 +284,7 @@ const make = input => {
   return duration;
 };
 /**
- * Checks if a value is a Duration.
+ * Checks whether a value is a Duration.
  *
  * **Example** (Checking for durations)
  *
@@ -300,7 +300,7 @@ const make = input => {
  */
 export const isDuration = u => hasProperty(u, TypeId);
 /**
- * Checks if a Duration is finite (not infinite).
+ * Checks whether a Duration is finite (not infinite).
  *
  * **Example** (Checking finite durations)
  *
@@ -316,7 +316,7 @@ export const isDuration = u => hasProperty(u, TypeId);
  */
 export const isFinite = self => self.value._tag !== "Infinity" && self.value._tag !== "NegativeInfinity";
 /**
- * Checks if a Duration is zero.
+ * Checks whether a Duration is zero.
  *
  * **Example** (Checking for zero durations)
  *
@@ -424,7 +424,7 @@ export const abs = self => {
   }
 };
 /**
- * Negates the duration.
+ * Returns the negated duration.
  *
  * **Example** (Negating durations)
  *
@@ -750,7 +750,7 @@ export const toWeeks = self => match(fromInputUnsafe(self), {
   onNegativeInfinity: () => -Infinity
 });
 /**
- * Get the duration in nanoseconds as a bigint.
+ * Gets the duration in nanoseconds as a bigint, throwing for infinite durations.
  *
  * **Gotchas**
  *
@@ -785,7 +785,7 @@ export const toNanosUnsafe = input => {
   }
 };
 /**
- * Get the duration in nanoseconds as a bigint.
+ * Gets the duration in nanoseconds safely as an `Option<bigint>`.
  *
  * **Details**
  *
@@ -910,7 +910,7 @@ export const matchPair = /*#__PURE__*/dual(3, (self, that, options) => {
   }
 });
 /**
- * Order instance for `Duration`, allowing comparison operations.
+ * Provides an `Order` instance for comparing `Duration` values.
  *
  * **Details**
  *
@@ -984,7 +984,7 @@ export const Order = /*#__PURE__*/order.make((self, that) => matchPair(self, tha
  */
 export const between = /*#__PURE__*/order.isBetween(Order);
 /**
- * Equivalence instance for `Duration`, allowing equality comparisons.
+ * Provides an `Equivalence` instance for comparing `Duration` values.
  *
  * **Example** (Comparing durations for equivalence)
  *
@@ -1015,7 +1015,7 @@ export const Equivalence = (self, that) => matchPair(self, that, {
  * console.log(Duration.toSeconds(shorter)) // 3
  * ```
  *
- * @category order
+ * @category ordering
  * @since 2.0.0
  */
 export const min = /*#__PURE__*/order.min(Order);
@@ -1036,7 +1036,7 @@ export const min = /*#__PURE__*/order.min(Order);
  */
 export const max = /*#__PURE__*/order.max(Order);
 /**
- * Clamps a Duration between a minimum and maximum value.
+ * Returns a `Duration` constrained between a minimum and maximum value.
  *
  * **Example** (Clamping durations to a range)
  *
@@ -1055,7 +1055,7 @@ export const max = /*#__PURE__*/order.max(Order);
  */
 export const clamp = /*#__PURE__*/order.clamp(Order);
 /**
- * Safely divides a `Duration` by a finite, non-zero number.
+ * Divides a `Duration` by a finite, non-zero number safely.
  *
  * **Details**
  *
@@ -1143,7 +1143,7 @@ export const divideUnsafe = /*#__PURE__*/dual(2, (self, by) => {
   });
 });
 /**
- * Multiplies a `Duration` by a number.
+ * Returns a `Duration` multiplied by a number.
  *
  * **Details**
  *
@@ -1249,7 +1249,7 @@ export const sum = /*#__PURE__*/dual(2, (self, that) => matchPair(self, that, {
   }
 }));
 /**
- * Checks if the first Duration is less than the second.
+ * Checks whether the first Duration is less than the second.
  *
  * **Example** (Comparing durations with less than)
  *
@@ -1265,7 +1265,7 @@ export const sum = /*#__PURE__*/dual(2, (self, that) => matchPair(self, that, {
  */
 export const isLessThan = /*#__PURE__*/order.isLessThan(Order);
 /**
- * Checks if the first Duration is less than or equal to the second.
+ * Checks whether the first Duration is less than or equal to the second.
  *
  * **Example** (Comparing durations with less than or equal)
  *
@@ -1284,7 +1284,7 @@ export const isLessThan = /*#__PURE__*/order.isLessThan(Order);
  */
 export const isLessThanOrEqualTo = /*#__PURE__*/order.isLessThanOrEqualTo(Order);
 /**
- * Checks if the first Duration is greater than the second.
+ * Checks whether the first Duration is greater than the second.
  *
  * **Example** (Comparing durations with greater than)
  *
@@ -1300,7 +1300,7 @@ export const isLessThanOrEqualTo = /*#__PURE__*/order.isLessThanOrEqualTo(Order)
  */
 export const isGreaterThan = /*#__PURE__*/order.isGreaterThan(Order);
 /**
- * Checks if the first Duration is greater than or equal to the second.
+ * Checks whether the first Duration is greater than or equal to the second.
  *
  * **Example** (Comparing durations with greater than or equal)
  *
@@ -1319,7 +1319,7 @@ export const isGreaterThan = /*#__PURE__*/order.isGreaterThan(Order);
  */
 export const isGreaterThanOrEqualTo = /*#__PURE__*/order.isGreaterThanOrEqualTo(Order);
 /**
- * Checks if two Durations are equal.
+ * Checks whether two Durations are equal.
  *
  * **Example** (Checking duration equality)
  *
@@ -1473,7 +1473,7 @@ export const format = self => {
   return pieces.join(" ");
 };
 /**
- * A `Reducer` for summing `Duration`s.
+ * Reducer for summing `Duration`s.
  *
  * **When to use**
  *
@@ -1493,7 +1493,7 @@ export const format = self => {
  */
 export const ReducerSum = /*#__PURE__*/Reducer.make(sum, zero);
 /**
- * A `Combiner` that returns the maximum `Duration`.
+ * Combiner that returns the maximum `Duration`.
  *
  * **When to use**
  *
@@ -1507,7 +1507,7 @@ export const ReducerSum = /*#__PURE__*/Reducer.make(sum, zero);
  */
 export const CombinerMax = /*#__PURE__*/Combiner.max(Order);
 /**
- * A `Combiner` that returns the minimum `Duration`.
+ * Combiner that returns the minimum `Duration`.
  *
  * **When to use**
  *