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

package/src/ScopedCache.ts

@@ -612,7 +612,7 @@ export const getSuccess: {
 )
 
 /**
- * Stores a successful value for a key without running the lookup function.
+ * Sets a successful value for a key without running the lookup function.
  *
  * **When to use**
  *
@@ -633,7 +633,7 @@ export const getSuccess: {
  */
 export const set: {
   /**
-   * Stores a successful value for a key without running the lookup function.
+   * Sets a successful value for a key without running the lookup function.
    *
    * **When to use**
    *
@@ -654,7 +654,7 @@ export const set: {
    */
   <Key, A>(key: Key, value: A): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<void>
   /**
-   * Stores a successful value for a key without running the lookup function.
+   * Sets a successful value for a key without running the lookup function.
    *
    * **When to use**
    *
@@ -686,7 +686,7 @@ export const set: {
         const state = self.state
         const exit = core.exitSucceed(value)
         const deferred = Deferred.makeUnsafe</**
-         * Stores a successful value for a key without running the lookup function.
+         * Sets a successful value for a key without running the lookup function.
          *
          * **When to use**
          *
@@ -706,7 +706,7 @@ export const set: {
          * @since 4.0.0
          */
         A, /**
-         * Stores a successful value for a key without running the lookup function.
+         * Sets a successful value for a key without running the lookup function.
          *
          * **When to use**
          *
@@ -744,7 +744,7 @@ export const set: {
 )
 
 /**
- * Checks if the cache contains an entry for the specified key.
+ * Checks whether the cache contains an entry for the specified key.
  *
  * **When to use**
  *
@@ -765,7 +765,7 @@ export const set: {
  */
 export const has: {
   /**
-   * Checks if the cache contains an entry for the specified key.
+   * Checks whether the cache contains an entry for the specified key.
    *
    * **When to use**
    *
@@ -786,7 +786,7 @@ export const has: {
    */
   <Key, A>(key: Key): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<boolean>
   /**
-   * Checks if the cache contains an entry for the specified key.
+   * Checks whether the cache contains an entry for the specified key.
    *
    * **When to use**
    *
@@ -902,8 +902,8 @@ export const invalidate: {
   ))
 
 /**
- * Conditionally invalidates the entry associated with the specified key in the cache
- * if the predicate returns true for the cached value.
+ * Invalidates the entry associated with the specified key in the cache when the
+ * predicate returns true for the cached value.
  *
  * **When to use**
  *
@@ -926,8 +926,8 @@ export const invalidate: {
  */
 export const invalidateWhen: {
   /**
-   * Conditionally invalidates the entry associated with the specified key in the cache
-   * if the predicate returns true for the cached value.
+   * Invalidates the entry associated with the specified key in the cache when the
+   * predicate returns true for the cached value.
    *
    * **When to use**
    *
@@ -950,8 +950,8 @@ export const invalidateWhen: {
    */
   <Key, A>(key: Key, f: Predicate.Predicate<A>): <E, R>(self: ScopedCache<Key, A, E, R>) => Effect.Effect<boolean>
   /**
-   * Conditionally invalidates the entry associated with the specified key in the cache
-   * if the predicate returns true for the cached value.
+   * Invalidates the entry associated with the specified key in the cache when the
+   * predicate returns true for the cached value.
    *
    * **When to use**
    *

package/src/ScopedRef.ts

@@ -101,7 +101,7 @@ export const fromAcquire: <A, E, R>(
 }, Effect.uninterruptible)
 
 /**
- * Retrieves the current value of the scoped reference.
+ * Retrieves the current value of the scoped reference synchronously.
  *
  * **When to use**
  *
@@ -116,7 +116,7 @@ export const fromAcquire: <A, E, R>(
 export const getUnsafe = <A>(self: ScopedRef<A>): A => self.backing.backing.ref.current[1]
 
 /**
- * Retrieves the current value of the scoped reference.
+ * Retrieves the current value of the scoped reference effectfully.
  *
  * **When to use**
  *

package/src/Semaphore.ts

@@ -172,7 +172,7 @@ export interface Semaphore {
 }
 
 /**
- * Synchronously creates a `Semaphore` initialized with the specified total
+ * Creates a `Semaphore` synchronously with the specified total
  * number of permits.
  *
  * **When to use**

package/src/Sink.ts

@@ -213,7 +213,7 @@ const SinkProto = {
 }
 
 /**
- * Checks if a value is a Sink.
+ * Checks whether a value is a Sink.
  *
  * **Example** (Checking for a sink)
  *
@@ -701,7 +701,7 @@ export const ignoreLeftover = <A, In, L, E, R>(self: Sink<A, In, L, E, R>): Sink
   mapEnd(self, ([a]) => [a])
 
 /**
- * Drains elements from the stream by ignoring all inputs.
+ * Consumes and ignores all stream inputs.
  *
  * **When to use**
  *
@@ -941,7 +941,7 @@ export const map: {
 )
 
 /**
- * Set the sink's result to a constant value.
+ * Sets the sink's result to a constant value.
  *
  * **When to use**
  *
@@ -955,7 +955,7 @@ export const map: {
  */
 export const as: {
   /**
-   * Set the sink's result to a constant value.
+   * Sets the sink's result to a constant value.
    *
    * **When to use**
    *
@@ -969,7 +969,7 @@ export const as: {
    */
   <A2>(a2: A2): <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A2, In, L, E, R>
   /**
-   * Set the sink's result to a constant value.
+   * Sets the sink's result to a constant value.
    *
    * **When to use**
    *
@@ -1015,21 +1015,21 @@ export const mapInput: {
 )
 
 /**
- * Effectfully transforms this sink's input elements.
+ * Transforms this sink's input elements effectfully.
  *
  * @category mapping
  * @since 2.0.0
  */
 export const mapInputEffect: {
   /**
-   * Effectfully transforms this sink's input elements.
+   * Transforms this sink's input elements effectfully.
    *
    * @category mapping
    * @since 2.0.0
    */
   <In0, In, E2, R2>(f: (input: In0) => Effect.Effect<In, E2, R2>): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>
   /**
-   * Effectfully transforms this sink's input elements.
+   * Transforms this sink's input elements effectfully.
    *
    * @category mapping
    * @since 2.0.0
@@ -1081,7 +1081,7 @@ export const mapInputArray: {
 )
 
 /**
- * Effectfully transforms each non-empty array of upstream input before it is
+ * Transforms each non-empty array of upstream input effectfully before it is
  * fed to this sink.
  *
  * @category mapping
@@ -1089,7 +1089,7 @@ export const mapInputArray: {
  */
 export const mapInputArrayEffect: {
   /**
-   * Effectfully transforms each non-empty array of upstream input before it is
+   * Transforms each non-empty array of upstream input effectfully before it is
    * fed to this sink.
    *
    * @category mapping
@@ -1099,7 +1099,7 @@ export const mapInputArrayEffect: {
     f: (input: Arr.NonEmptyReadonlyArray<In0>) => Effect.Effect<Arr.NonEmptyReadonlyArray<In>, E2, R2>
   ): <A, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In0, L, E2 | E, R2 | R>
   /**
-   * Effectfully transforms each non-empty array of upstream input before it is
+   * Transforms each non-empty array of upstream input effectfully before it is
    * fed to this sink.
    *
    * @category mapping
@@ -1176,7 +1176,7 @@ const transformEffect = <A, In, L, E, R, A2, E2, R2, L2 = never>(
 ): Sink<A2, In, L2, E2, R2> => fromTransform((upstream, scope) => f(self.transform(upstream, scope)))
 
 /**
- * Effectfully transforms the full `End` produced by this sink.
+ * Transforms the full `End` produced by this sink effectfully.
  *
  * **Details**
  *
@@ -1188,7 +1188,7 @@ const transformEffect = <A, In, L, E, R, A2, E2, R2, L2 = never>(
  */
 export const mapEffectEnd: {
   /**
-   * Effectfully transforms the full `End` produced by this sink.
+   * Transforms the full `End` produced by this sink effectfully.
    *
    * **Details**
    *
@@ -1200,7 +1200,7 @@ export const mapEffectEnd: {
    */
   <A, L, A2, E2, R2, L2 = never>(f: (end: End<A, L>) => Effect.Effect<End<A2, L2>, E2, R2>): <In, E, R>(self: Sink<A, In, L, E, R>) => Sink<A2, In, L2, E2 | E, R2 | R>
   /**
-   * Effectfully transforms the full `End` produced by this sink.
+   * Transforms the full `End` produced by this sink effectfully.
    *
    * **Details**
    *
@@ -1220,7 +1220,7 @@ export const mapEffectEnd: {
 ): Sink<A2, In, L2, E | E2, R | R2> => transformEffect(self, Effect.flatMap(f)))
 
 /**
- * Effectfully transforms this sink's result.
+ * Transforms this sink's result effectfully.
  *
  * **When to use**
  *
@@ -1241,7 +1241,7 @@ export const mapEffectEnd: {
  */
 export const mapEffect: {
   /**
-   * Effectfully transforms this sink's result.
+   * Transforms this sink's result effectfully.
    *
    * **When to use**
    *
@@ -1262,7 +1262,7 @@ export const mapEffect: {
    */
   <A, A2, E2, R2>(f: (a: A) => Effect.Effect<A2, E2, R2>): <In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A2, In, L, E2 | E, R2 | R>
   /**
-   * Effectfully transforms this sink's result.
+   * Transforms this sink's result effectfully.
    *
    * **When to use**
    *
@@ -1479,8 +1479,8 @@ export const flatMap: {
   }))
 
 /**
- * A sink that reduces its inputs using the provided function `f` starting from
- * the provided `initial` state while the specified `predicate` returns `true`.
+ * A sink that reduces input elements from the provided `initial` state with
+ * `f` while the specified `predicate` returns `true`.
  *
  * @category reducing
  * @since 4.0.0
@@ -1515,9 +1515,8 @@ export const reduceWhile = <S, In>(
   })
 
 /**
- * A sink that reduces its inputs using the provided effectful function `f`
- * starting from the provided `initial` state while the specified `predicate`
- * returns `true`.
+ * A sink that effectfully reduces input elements from the provided `initial`
+ * state with `f` while the specified `predicate` returns `true`.
  *
  * @category reducing
  * @since 4.0.0
@@ -1557,8 +1556,8 @@ export const reduceWhileEffect = <S, In, E, R>(
   })
 
 /**
- * A sink that reduces its inputs using the provided function `f` starting from
- * the provided `initial` state while the specified `predicate` returns `true`.
+ * A sink that reduces non-empty input arrays from the provided `initial` state
+ * with `f` while the specified `predicate` returns `true`.
  *
  * @category reducing
  * @since 4.0.0
@@ -1589,9 +1588,8 @@ export const reduceWhileArray = <S, In>(
   })
 
 /**
- * A sink that reduces its inputs using the provided effectful function `f`
- * starting from the provided `initial` state while the specified `predicate`
- * returns `true`.
+ * A sink that effectfully reduces non-empty input arrays from the provided
+ * `initial` state with `f` while the specified `predicate` returns `true`.
  *
  * @category reducing
  * @since 4.0.0
@@ -1713,7 +1711,7 @@ const last_ = reduceArray(Option.none<unknown>, (_, arr) => Arr.last(arr))
 export const last = <In>(): Sink<Option.Option<In>, In> => last_ as any
 
 /**
- * Creates a sink containing the first matching value.
+ * Creates a sink containing the first value matched by a synchronous predicate.
  *
  * **When to use**
  *
@@ -1734,7 +1732,7 @@ export const last = <In>(): Sink<Option.Option<In>, In> => last_ as any
  */
 export const find: {
   /**
-   * Creates a sink containing the first matching value.
+   * Creates a sink containing the first value matched by a synchronous predicate.
    *
    * **When to use**
    *
@@ -1755,7 +1753,7 @@ export const find: {
    */
   <In, Out extends In>(refinement: Refinement<In, Out>): Sink<Option.Option<Out>, In, In>
   /**
-   * Creates a sink containing the first matching value.
+   * Creates a sink containing the first value matched by a synchronous predicate.
    *
    * **When to use**
    *
@@ -1783,7 +1781,7 @@ export const find: {
   )
 
 /**
- * Creates a sink containing the first matching value.
+ * Creates a sink containing the first value matched by an effectful predicate.
  *
  * **When to use**
  *
@@ -1952,7 +1950,7 @@ export const takeWhileFilter = <In, Out, X>(
   })
 
 /**
- * Effectfully collects input elements while the predicate succeeds.
+ * Collects input elements effectfully while the predicate succeeds.
  *
  * **Details**
  *
@@ -1965,7 +1963,7 @@ export const takeWhileFilter = <In, Out, X>(
  */
 export const takeWhileEffect: {
   /**
-   * Effectfully collects input elements while the predicate succeeds.
+   * Collects input elements effectfully while the predicate succeeds.
    *
    * **Details**
    *
@@ -2013,7 +2011,7 @@ export const takeWhileEffect: {
   })
 
 /**
- * Effectfully applies a `FilterEffect` to input elements while it succeeds,
+ * Applies a `FilterEffect` to input elements effectfully while it succeeds,
  * collecting each successful output.
  *
  * **Details**
@@ -2072,7 +2070,7 @@ export const takeUntil = <In>(predicate: Predicate<In>): Sink<Array<In>, In, In>
   })
 
 /**
- * Effectfully collects input elements until the predicate returns `true`,
+ * Collects input elements effectfully until the predicate returns `true`,
  * including the matching element in the result.
  *
  * **Details**
@@ -2245,24 +2243,21 @@ export const unwrap = <A, In, L, E, R, R2>(
 ): Sink<A, In, L, E, Exclude<R, Scope.Scope> | R2> => fromChannel(Channel.unwrap(Effect.map(effect, toChannel)))
 
 /**
- * Summarize a sink by running an effect when the sink starts and again when
- * it completes.
+ * Runs a summary effect when the sink starts and again when it completes.
  *
  * @category utils
  * @since 2.0.0
  */
 export const summarized: {
   /**
-   * Summarize a sink by running an effect when the sink starts and again when
-   * it completes.
+   * Runs a summary effect when the sink starts and again when it completes.
    *
    * @category utils
    * @since 2.0.0
    */
   <A2, E2, R2, A3>(summary: Effect.Effect<A2, E2, R2>, f: (start: A2, end: A2) => A3): <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<[A, A3], In, L, E2 | E, R2 | R>
   /**
-   * Summarize a sink by running an effect when the sink starts and again when
-   * it completes.
+   * Runs a summary effect when the sink starts and again when it completes.
    *
    * @category utils
    * @since 2.0.0

package/src/Stdio.ts

@@ -52,9 +52,10 @@ export type TypeId = "~effect/Stdio"
 /**
  * Runtime identifier stored on `Stdio` service implementations.
  *
- * **When to use**
+ * **Details**
  *
- * Use to mark and recognize concrete `Stdio` service values at runtime.
+ * This marker is part of the runtime representation of `Stdio` service
+ * implementations.
  *
  * @category type IDs
  * @since 4.0.0
@@ -62,7 +63,7 @@ export type TypeId = "~effect/Stdio"
 export const TypeId: TypeId = "~effect/Stdio"
 
 /**
- * Service interface for process standard I/O.
+ * Defines the service interface for process standard I/O.
  *
  * **When to use**
  *
@@ -90,7 +91,7 @@ export interface Stdio {
   readonly stdin: Stream.Stream<Uint8Array, PlatformError>
 }
 /**
- * Context service tag for the `Stdio` service.
+ * Service tag for process standard I/O.
  *
  * **When to use**
  *