effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/Sink.ts

@@ -101,6 +101,8 @@ export interface Sink<out A, in In = unknown, out L = never, out E = never, out
 /**
  * Tuple returned when a `Sink` finishes.
  *
+ * **Details**
+ *
  * The first element is the sink result. The optional second element contains a
  * non-empty array of leftover input that was pulled but not consumed.
  *
@@ -114,6 +116,8 @@ const endVoid = Effect.succeed([void 0] as End<void, never>)
 /**
  * Type-level unification support for `Sink` values.
  *
+ * **Details**
+ *
  * This preserves the result, input, leftover, error, and service type
  * parameters when Effect's `Unify` machinery normalizes generic values that
  * include sinks. Users normally do not need to reference this interface
@@ -138,6 +142,8 @@ export interface SinkUnify<A extends { [Unify.typeSymbol]?: any }> extends Effec
 /**
  * Marker used by Effect's `Unify` machinery for `Sink` values.
  *
+ * **Details**
+ *
  * It prevents the inherited `Effect` unifier from being selected when
  * sink-specific unification should preserve the `Sink` type parameters. Users
  * normally do not need to reference this interface directly.
@@ -158,6 +164,8 @@ export declare namespace Sink {
   /**
    * Type-level variance marker for `Sink`.
    *
+   * **Details**
+   *
    * The result `A`, leftovers `L`, errors `E`, and services `R` are
    * covariant. The input type `In` is contravariant because values flow into
    * the sink.
@@ -172,6 +180,8 @@ export declare namespace Sink {
    * Structural encoding used by `Sink.Variance` to record each `Sink` type
    * parameter's variance.
    *
+   * **Details**
+   *
    * `_A`, `_L`, `_E`, and `_R` are covariant markers. `_In` is a
    * contravariant marker.
    *
@@ -249,6 +259,8 @@ export const fromChannel = <L, In, E, A, R>(
 /**
  * Creates a `Sink` from a low-level transform function.
  *
+ * **Details**
+ *
  * The transform receives the upstream pull of non-empty input arrays and the
  * active scope, and returns an effect that completes with the sink's `End`
  * value.
@@ -296,6 +308,8 @@ export const toChannel = <A, In, L, E, R>(
 /**
  * Creates a pipe-style constructor for sinks over input type `In`.
  *
+ * **Details**
+ *
  * The returned function exposes the sink input as a `Stream<In>`, applies the
  * provided pipeline, and uses the final effect's success value as the sink
  * result.
@@ -323,6 +337,8 @@ export declare namespace make {
   /**
    * Overloaded function type returned by `Sink.make`.
    *
+   * **Details**
+   *
    * The first pipeline function receives the sink input as a `Stream<In>`. The
    * final pipeline step must return an `Effect`, whose success value becomes
    * the sink result.
@@ -424,6 +440,8 @@ export declare namespace make {
  * Creates a sink that ignores upstream input and completes from an effect that
  * already returns an `End`.
  *
+ * **When to use**
+ *
  * Use this when the effect needs to provide both the result value and optional
  * leftovers.
  *
@@ -438,6 +456,8 @@ export const fromEffectEnd = <A, E, R, L = never>(
  * Creates a sink that ignores upstream input and completes with the success
  * value of the provided effect.
  *
+ * **Details**
+ *
  * If the effect fails, the sink fails with the same error.
  *
  * @category constructors
@@ -450,6 +470,8 @@ export const fromEffect = <A, E, R>(
 /**
  * Creates a sink that offers every consumed input element to a queue.
  *
+ * **Details**
+ *
  * When the upstream stream ends, the sink ends the queue and completes with
  * `void`.
  *
@@ -473,6 +495,8 @@ export const fromQueue = <A>(
 /**
  * Creates a sink that publishes every consumed input element to a `PubSub`.
  *
+ * **Details**
+ *
  * The sink completes with `void` when the upstream stream ends.
  *
  * @category constructors
@@ -658,6 +682,8 @@ export const never: Sink<unknown> = fromEffectEnd(Effect.never)
 /**
  * Drops leftovers produced by a sink.
  *
+ * **Details**
+ *
  * The sink result is preserved, but any leftover elements are discarded
  * instead of being returned to downstream sink composition. This does not
  * continue pulling additional elements from the upstream stream.
@@ -715,6 +741,8 @@ export const fold = <S, In, E = never, R = never>(
 /**
  * Folds non-empty input arrays into state with an effectful function.
  *
+ * **Details**
+ *
  * The initial state is evaluated lazily. After each pulled array is folded,
  * the sink continues while `contFn` returns `true`; otherwise it completes
  * with the current state.
@@ -745,6 +773,8 @@ export const foldArray = <S, In, E = never, R = never>(
  * Folds input elements into state until the specified maximum number of
  * elements has been consumed or the upstream stream ends.
  *
+ * **Details**
+ *
  * If the sink stops in the middle of a pulled array, the remaining elements
  * from that array are returned as leftovers.
  *
@@ -982,6 +1012,8 @@ export const mapInputArrayEffect: {
 /**
  * Transforms the full `End` produced by this sink.
  *
+ * **Details**
+ *
  * This can change both the result value and the optional leftovers.
  *
  * @category mapping
@@ -991,6 +1023,8 @@ export const mapEnd: {
   /**
    * Transforms the full `End` produced by this sink.
    *
+   * **Details**
+   *
    * This can change both the result value and the optional leftovers.
    *
    * @category mapping
@@ -1000,6 +1034,8 @@ export const mapEnd: {
   /**
    * Transforms the full `End` produced by this sink.
    *
+   * **Details**
+   *
    * This can change both the result value and the optional leftovers.
    *
    * @category mapping
@@ -1028,6 +1064,8 @@ const transformEffect = <A, In, L, E, R, A2, E2, R2, L2 = never>(
 /**
  * Effectfully transforms the full `End` produced by this sink.
  *
+ * **Details**
+ *
  * This can change both the result value and the optional leftovers, and the
  * transformation can fail or require services.
  *
@@ -1038,6 +1076,8 @@ export const mapEffectEnd: {
   /**
    * Effectfully transforms the full `End` produced by this sink.
    *
+   * **Details**
+   *
    * This can change both the result value and the optional leftovers, and the
    * transformation can fail or require services.
    *
@@ -1048,6 +1088,8 @@ export const mapEffectEnd: {
   /**
    * Effectfully transforms the full `End` produced by this sink.
    *
+   * **Details**
+   *
    * This can change both the result value and the optional leftovers, and the
    * transformation can fail or require services.
    *
@@ -1144,6 +1186,8 @@ export const mapLeftover: {
 /**
  * Collects up to `n` input elements into an array.
  *
+ * **Details**
+ *
  * If `n` is less than or equal to zero, the sink completes with an empty array.
  * If more elements are pulled than needed, the remaining elements from the same
  * array are returned as leftovers.
@@ -1188,6 +1232,8 @@ export const take = <In>(n: number): Sink<Array<In>, In, In> =>
  * another sink from the provided function which will continue to run until it
  * yields a result.
  *
+ * **Details**
+ *
  * This function essentially runs sinks in sequence.
  *
  * @category sequencing
@@ -1199,6 +1245,8 @@ export const flatMap: {
    * another sink from the provided function which will continue to run until it
    * yields a result.
    *
+   * **Details**
+   *
    * This function essentially runs sinks in sequence.
    *
    * @category sequencing
@@ -1210,6 +1258,8 @@ export const flatMap: {
    * another sink from the provided function which will continue to run until it
    * yields a result.
    *
+   * **Details**
+   *
    * This function essentially runs sinks in sequence.
    *
    * @category sequencing
@@ -1537,6 +1587,8 @@ export const collect = <In>(): Sink<Array<In>, In> =>
  * Collects the longest input prefix whose elements satisfy the predicate or
  * refinement.
  *
+ * **Details**
+ *
  * The first failing input is consumed and excluded from the result. Any later
  * elements from the same pulled array are returned as leftovers.
  *
@@ -1548,6 +1600,8 @@ export const takeWhile: {
    * Collects the longest input prefix whose elements satisfy the predicate or
    * refinement.
    *
+   * **Details**
+   *
    * The first failing input is consumed and excluded from the result. Any later
    * elements from the same pulled array are returned as leftovers.
    *
@@ -1559,6 +1613,8 @@ export const takeWhile: {
    * Collects the longest input prefix whose elements satisfy the predicate or
    * refinement.
    *
+   * **Details**
+   *
    * The first failing input is consumed and excluded from the result. Any later
    * elements from the same pulled array are returned as leftovers.
    *
@@ -1591,6 +1647,8 @@ export const takeWhile: {
  * Applies a `Filter` to input elements while it succeeds, collecting each
  * successful output.
  *
+ * **Details**
+ *
  * The first input for which the filter fails is consumed and excluded from the
  * result. Any later elements from the same pulled array are returned as
  * leftovers.
@@ -1625,6 +1683,8 @@ export const takeWhileFilter = <In, Out, X>(
 /**
  * Effectfully collects input elements while the predicate succeeds.
  *
+ * **Details**
+ *
  * The first input for which the predicate returns `false` is consumed and
  * excluded from the result. Any later elements from the same pulled array are
  * returned as leftovers.
@@ -1636,6 +1696,8 @@ export const takeWhileEffect: {
   /**
    * Effectfully collects input elements while the predicate succeeds.
    *
+   * **Details**
+   *
    * The first input for which the predicate returns `false` is consumed and
    * excluded from the result. Any later elements from the same pulled array are
    * returned as leftovers.
@@ -1683,6 +1745,8 @@ export const takeWhileEffect: {
  * Effectfully applies a `FilterEffect` to input elements while it succeeds,
  * collecting each successful output.
  *
+ * **Details**
+ *
  * The first input for which the filter fails is consumed and excluded from the
  * result. Any later elements from the same pulled array are returned as
  * leftovers.
@@ -1740,6 +1804,8 @@ export const takeUntil = <In>(predicate: Predicate<In>): Sink<Array<In>, In, In>
  * Effectfully collects input elements until the predicate returns `true`,
  * including the matching element in the result.
  *
+ * **Details**
+ *
  * If the predicate effect fails, the sink fails with the same error.
  *
  * @category constructors
@@ -1832,6 +1898,8 @@ export const forEachArray = <In, X, E, R>(
 /**
  * Runs an effectful function for each input element while it returns `true`.
  *
+ * **Details**
+ *
  * The sink stops consuming input when the function returns `false` or when the
  * upstream stream ends, and completes with `void`.
  *
@@ -1853,6 +1921,8 @@ export const forEachWhile = <In, E, R>(
  * Runs an effectful function for each non-empty input array while it returns
  * `true`.
  *
+ * **Details**
+ *
  * The sink stops consuming input when the function returns `false` or when the
  * upstream stream ends, and completes with `void`.
  *
@@ -1965,6 +2035,8 @@ export const timed: Sink<Duration.Duration, unknown> = map(withDuration(drain),
 /**
  * Provides a `Context` to this sink.
  *
+ * **Details**
+ *
  * Services contained in the provided context are removed from the sink's
  * service requirements.
  *
@@ -1975,6 +2047,8 @@ export const provideContext: {
   /**
    * Provides a `Context` to this sink.
    *
+   * **Details**
+   *
    * Services contained in the provided context are removed from the sink's
    * service requirements.
    *
@@ -1985,6 +2059,8 @@ export const provideContext: {
   /**
    * Provides a `Context` to this sink.
    *
+   * **Details**
+   *
    * Services contained in the provided context are removed from the sink's
    * service requirements.
    *
@@ -2005,6 +2081,8 @@ export const provideContext: {
 /**
  * Provides a single service implementation to this sink.
  *
+ * **Details**
+ *
  * The service identified by `key` is removed from the sink's service
  * requirements.
  *
@@ -2015,6 +2093,8 @@ export const provideService: {
   /**
    * Provides a single service implementation to this sink.
    *
+   * **Details**
+   *
    * The service identified by `key` is removed from the sink's service
    * requirements.
    *
@@ -2025,6 +2105,8 @@ export const provideService: {
   /**
    * Provides a single service implementation to this sink.
    *
+   * **Details**
+   *
    * The service identified by `key` is removed from the sink's service
    * requirements.
    *
@@ -2050,6 +2132,8 @@ export const provideService: {
 /**
  * Runs a fallback sink if this sink fails with a typed error.
  *
+ * **Details**
+ *
  * The fallback is built from the error and continues consuming from the same
  * upstream stream. If the upstream stream had already ended, the fallback sees
  * the upstream end instead.
@@ -2061,6 +2145,8 @@ export const orElse: {
   /**
    * Runs a fallback sink if this sink fails with a typed error.
    *
+   * **Details**
+   *
    * The fallback is built from the error and continues consuming from the same
    * upstream stream. If the upstream stream had already ended, the fallback sees
    * the upstream end instead.
@@ -2072,6 +2158,8 @@ export const orElse: {
   /**
    * Runs a fallback sink if this sink fails with a typed error.
    *
+   * **Details**
+   *
    * The fallback is built from the error and continues consuming from the same
    * upstream stream. If the upstream stream had already ended, the fallback sees
    * the upstream end instead.
@@ -2108,6 +2196,8 @@ export const orElse: {
 /**
  * Handles failures from this sink by inspecting the full `Cause`.
  *
+ * **Details**
+ *
  * When this sink fails, the handler effect is run and its success value
  * becomes the sink result. If the handler fails, the returned sink fails with
  * that error.
@@ -2119,6 +2209,8 @@ export const catchCause: {
   /**
    * Handles failures from this sink by inspecting the full `Cause`.
    *
+   * **Details**
+   *
    * When this sink fails, the handler effect is run and its success value
    * becomes the sink result. If the handler fails, the returned sink fails with
    * that error.
@@ -2130,6 +2222,8 @@ export const catchCause: {
   /**
    * Handles failures from this sink by inspecting the full `Cause`.
    *
+   * **Details**
+   *
    * When this sink fails, the handler effect is run and its success value
    * becomes the sink result. If the handler fails, the returned sink fails with
    * that error.
@@ -2169,6 +2263,8 @@ const catch_: {
 
 export {
   /**
+   * Handles typed errors from this sink with an effectful fallback value.
+   *
    * @category error handling
    * @since 4.0.0
    */
@@ -2178,6 +2274,8 @@ export {
 /**
  * Runs an effect after this sink completes, fails, or is interrupted.
  *
+ * **Details**
+ *
  * The effect receives the sink's `Exit` for the result value. The original
  * sink result and leftovers are preserved unless the finalizer itself fails.
  *
@@ -2188,6 +2286,8 @@ export const onExit: {
   /**
    * Runs an effect after this sink completes, fails, or is interrupted.
    *
+   * **Details**
+   *
    * The effect receives the sink's `Exit` for the result value. The original
    * sink result and leftovers are preserved unless the finalizer itself fails.
    *
@@ -2198,6 +2298,8 @@ export const onExit: {
   /**
    * Runs an effect after this sink completes, fails, or is interrupted.
    *
+   * **Details**
+   *
    * The effect receives the sink's `Exit` for the result value. The original
    * sink result and leftovers are preserved unless the finalizer itself fails.
    *
@@ -2220,6 +2322,8 @@ export const onExit: {
 /**
  * Runs a finalizer effect after this sink completes, fails, or is interrupted.
  *
+ * **Details**
+ *
  * The original sink result and leftovers are preserved unless the finalizer
  * itself fails.
  *
@@ -2230,6 +2334,8 @@ export const ensuring: {
   /**
    * Runs a finalizer effect after this sink completes, fails, or is interrupted.
    *
+   * **Details**
+   *
    * The original sink result and leftovers are preserved unless the finalizer
    * itself fails.
    *
@@ -2240,6 +2346,8 @@ export const ensuring: {
   /**
    * Runs a finalizer effect after this sink completes, fails, or is interrupted.
    *
+   * **Details**
+   *
    * The original sink result and leftovers are preserved unless the finalizer
    * itself fails.
    *

package/src/Stdio.ts

@@ -43,9 +43,11 @@ export const TypeId: TypeId = "~effect/Stdio"
 /**
  * Service interface for process standard I/O.
  *
- * It provides command-line arguments, sinks for standard output and standard
- * error, and a stream of standard input bytes. I/O operations can fail with
- * `PlatformError`.
+ * **Details**
+ *
+ * The service provides command-line arguments, sinks for standard output and
+ * standard error, and a stream of standard input bytes. I/O operations can fail
+ * with `PlatformError`.
  *
  * @category models
  * @since 4.0.0
@@ -84,6 +86,8 @@ export const make = (options: Omit<Stdio, TypeId>): Stdio => ({
 /**
  * Creates a test layer for `Stdio`.
  *
+ * **Details**
+ *
  * Any provided fields override defaults. By default, arguments are empty,
  * standard output and error are draining sinks, and standard input is an empty
  * stream.