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

package/src/Deferred.ts

@@ -184,7 +184,7 @@ const DeferredProto = {
 }
 
 /**
- * Synchronously creates an empty `Deferred` outside the `Effect` runtime.
+ * Creates an empty `Deferred` synchronously outside the `Effect` runtime.
  *
  * **When to use**
  *
@@ -521,7 +521,7 @@ export const completeWith: {
 )
 
 /**
- * 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**
@@ -557,7 +557,7 @@ export const completeWith: {
  */
 export 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**
@@ -593,7 +593,7 @@ export 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**
@@ -1382,7 +1382,7 @@ export const interruptWith: {
 export const isDone = <A, E>(self: Deferred<A, E>): Effect<boolean> => 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**
  *
@@ -1628,7 +1628,7 @@ export const sync: {
 )
 
 /**
- * Synchronously attempts to complete the `Deferred` with the specified
+ * Attempts to complete the `Deferred` synchronously with the specified
  * completion effect.
  *
  * **When to use**

package/src/Duration.ts

@@ -327,7 +327,7 @@ const invalid = (input: unknown): never => {
 }
 
 /**
- * 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)
@@ -412,7 +412,7 @@ const make = (input: number | bigint): Duration => {
 }
 
 /**
- * Checks if a value is a Duration.
+ * Checks whether a value is a Duration.
  *
  * **Example** (Checking for durations)
  *
@@ -429,7 +429,7 @@ const make = (input: number | bigint): Duration => {
 export const isDuration = (u: unknown): u is Duration => hasProperty(u, TypeId)
 
 /**
- * Checks if a Duration is finite (not infinite).
+ * Checks whether a Duration is finite (not infinite).
  *
  * **Example** (Checking finite durations)
  *
@@ -447,7 +447,7 @@ export const isFinite = (self: Duration): boolean =>
   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)
  *
@@ -559,7 +559,7 @@ export const abs = (self: Duration): Duration => {
 }
 
 /**
- * Negates the duration.
+ * Returns the negated duration.
  *
  * **Example** (Negating durations)
  *
@@ -909,7 +909,7 @@ export 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**
  *
@@ -945,7 +945,7 @@ export const toNanosUnsafe = (input: Input): bigint => {
 }
 
 /**
- * Get the duration in nanoseconds as a bigint.
+ * Gets the duration in nanoseconds safely as an `Option<bigint>`.
  *
  * **Details**
  *
@@ -1223,7 +1223,7 @@ export const matchPair: {
 })
 
 /**
- * Order instance for `Duration`, allowing comparison operations.
+ * Provides an `Order` instance for comparing `Duration` values.
  *
  * **Details**
  *
@@ -1376,7 +1376,7 @@ export const between: {
 } = order.isBetween(Order)
 
 /**
- * Equivalence instance for `Duration`, allowing equality comparisons.
+ * Provides an `Equivalence` instance for comparing `Duration` values.
  *
  * **Example** (Comparing durations for equivalence)
  *
@@ -1409,7 +1409,7 @@ export const Equivalence: Equ.Equivalence<Duration> = (self, that) =>
  * console.log(Duration.toSeconds(shorter)) // 3
  * ```
  *
- * @category order
+ * @category ordering
  * @since 2.0.0
  */
 export const min: {
@@ -1425,7 +1425,7 @@ export const min: {
    * console.log(Duration.toSeconds(shorter)) // 3
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (that: Duration): (self: Duration) => Duration
@@ -1441,7 +1441,7 @@ export const min: {
    * console.log(Duration.toSeconds(shorter)) // 3
    * ```
    *
-   * @category order
+   * @category ordering
    * @since 2.0.0
    */
   (self: Duration, that: Duration): Duration
@@ -1498,7 +1498,7 @@ export const max: {
 } = 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)
  *
@@ -1517,7 +1517,7 @@ export const max: {
  */
 export 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)
    *
@@ -1536,7 +1536,7 @@ export const clamp: {
    */
   (options: { minimum: Duration; 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)
    *
@@ -1557,7 +1557,7 @@ export const clamp: {
 } = order.clamp(Order)
 
 /**
- * Safely divides a `Duration` by a finite, non-zero number.
+ * Divides a `Duration` by a finite, non-zero number safely.
  *
  * **Details**
  *
@@ -1581,7 +1581,7 @@ export const clamp: {
  */
 export const divide: {
   /**
-   * Safely divides a `Duration` by a finite, non-zero number.
+   * Divides a `Duration` by a finite, non-zero number safely.
    *
    * **Details**
    *
@@ -1605,7 +1605,7 @@ export 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**
    *
@@ -1759,7 +1759,7 @@ export const divideUnsafe: {
 )
 
 /**
- * Multiplies a `Duration` by a number.
+ * Returns a `Duration` multiplied by a number.
  *
  * **Details**
  *
@@ -1782,7 +1782,7 @@ export const divideUnsafe: {
  */
 export const times: {
   /**
-   * Multiplies a `Duration` by a number.
+   * Returns a `Duration` multiplied by a number.
    *
    * **Details**
    *
@@ -1805,7 +1805,7 @@ export const times: {
    */
   (times: number): (self: Duration) => Duration
   /**
-   * Multiplies a `Duration` by a number.
+   * Returns a `Duration` multiplied by a number.
    *
    * **Details**
    *
@@ -2039,7 +2039,7 @@ export const sum: {
 )
 
 /**
- * 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)
  *
@@ -2055,7 +2055,7 @@ export const sum: {
  */
 export 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)
    *
@@ -2071,7 +2071,7 @@ export 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)
    *
@@ -2089,7 +2089,7 @@ export const isLessThan: {
 } = 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)
  *
@@ -2108,7 +2108,7 @@ export const isLessThan: {
  */
 export 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)
    *
@@ -2127,7 +2127,7 @@ export 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)
    *
@@ -2148,7 +2148,7 @@ export const isLessThanOrEqualTo: {
 } = 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)
  *
@@ -2164,7 +2164,7 @@ export const isLessThanOrEqualTo: {
  */
 export 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)
    *
@@ -2180,7 +2180,7 @@ export 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)
    *
@@ -2198,7 +2198,7 @@ export const isGreaterThan: {
 } = 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)
  *
@@ -2217,7 +2217,7 @@ export const isGreaterThan: {
  */
 export 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)
    *
@@ -2236,7 +2236,7 @@ export 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)
    *
@@ -2257,7 +2257,7 @@ export const isGreaterThanOrEqualTo: {
 } = order.isGreaterThanOrEqualTo(Order)
 
 /**
- * Checks if two Durations are equal.
+ * Checks whether two Durations are equal.
  *
  * **Example** (Checking duration equality)
  *
@@ -2273,7 +2273,7 @@ export const isGreaterThanOrEqualTo: {
  */
 export const equals: {
   /**
-   * Checks if two Durations are equal.
+   * Checks whether two Durations are equal.
    *
    * **Example** (Checking duration equality)
    *
@@ -2289,7 +2289,7 @@ export const equals: {
    */
   (that: Duration): (self: Duration) => boolean
   /**
-   * Checks if two Durations are equal.
+   * Checks whether two Durations are equal.
    *
    * **Example** (Checking duration equality)
    *
@@ -2463,7 +2463,7 @@ export const format = (self: Duration): string => {
 }
 
 /**
- * A `Reducer` for summing `Duration`s.
+ * Reducer for summing `Duration`s.
  *
  * **When to use**
  *
@@ -2484,7 +2484,7 @@ export const format = (self: Duration): string => {
 export const ReducerSum: Reducer.Reducer<Duration> = Reducer.make(sum, zero)
 
 /**
- * A `Combiner` that returns the maximum `Duration`.
+ * Combiner that returns the maximum `Duration`.
  *
  * **When to use**
  *
@@ -2499,7 +2499,7 @@ export const ReducerSum: Reducer.Reducer<Duration> = Reducer.make(sum, zero)
 export const CombinerMax: Combiner.Combiner<Duration> = Combiner.max(Order)
 
 /**
- * A `Combiner` that returns the minimum `Duration`.
+ * Combiner that returns the minimum `Duration`.
  *
  * **When to use**
  *