effect 4.0.0-beta.67 → 4.0.0-beta.69

package/src/Sink.ts

@@ -16,12 +16,11 @@
  * **Common tasks**
  *
  * - Create simple sinks: {@link succeed}, {@link fail}, {@link fromEffect}
- * - Fold input: {@link fold}, {@link foldEffect}, {@link foldLeft}
- * - Collect values: {@link collectAll}, {@link collectAllN}, {@link collectAllWhile}
+ * - Fold input: {@link fold}
+ * - Collect values: {@link collect}
  * - Count or drain input: {@link count}, {@link drain}
  * - Transform results: {@link map}, {@link mapEffect}, {@link as}
- * - Combine sinks: {@link zip}, {@link zipWith}, {@link race}
- * - Filter and refine input: {@link filterInput}, {@link filterInputEffect}
+ * - Adapt input before consumption: {@link mapInput}, {@link mapInputEffect}
  *
  * **Gotchas**
  *
@@ -71,9 +70,7 @@ const TypeId = "~effect/Sink"
  * **Example** (Running a sink with a stream)
  *
  * ```ts
- * import { Effect } from "effect"
- * import * as Sink from "effect/Sink"
- * import * as Stream from "effect/Stream"
+ * import { Effect, Sink, Stream } from "effect"
  *
  * // Create a simple sink that always succeeds with a value
  * const sink: Sink.Sink<number> = Sink.succeed(42)
@@ -108,7 +105,7 @@ export interface Sink<out A, in In = unknown, out L = never, out E = never, out
  * non-empty array of leftover input that was pulled but not consumed.
  *
  * @category models
- * @since 2.0.0
+ * @since 4.0.0
  */
 export type End<A, L = never> = readonly [value: A, leftover?: NonEmptyReadonlyArray<L> | undefined]
 
@@ -155,7 +152,6 @@ export interface SinkUnifyIgnore {
 /**
  * Namespace containing types and interfaces for Sink variance and type relationships.
  *
- * @category models
  * @since 2.0.0
  */
 export declare namespace Sink {
@@ -222,7 +218,7 @@ const SinkProto = {
  * ```
  *
  * @category guards
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const isSink = (u: unknown): u is Sink<unknown, never, unknown, unknown, unknown> => hasProperty(u, TypeId)
 
@@ -331,6 +327,7 @@ export declare namespace make {
    * final pipeline step must return an `Effect`, whose success value becomes
    * the sink result.
    *
+   * @category models
    * @since 4.0.0
    */
   export interface Constructor<In> {
@@ -444,7 +441,7 @@ export const fromEffectEnd = <A, E, R, L = never>(
  * If the effect fails, the sink fails with the same error.
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const fromEffect = <A, E, R>(
   effect: Effect.Effect<A, E, R>
@@ -723,7 +720,7 @@ export const fold = <S, In, E = never, R = never>(
  * with the current state.
  *
  * @category folding
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const foldArray = <S, In, E = never, R = never>(
   s: LazyArg<S>,
@@ -1253,7 +1250,7 @@ export const flatMap: {
  * the provided `initial` state while the specified `predicate` returns `true`.
  *
  * @category reducing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const reduceWhile = <S, In>(
   initial: LazyArg<S>,
@@ -1290,7 +1287,7 @@ export const reduceWhile = <S, In>(
  * returns `true`.
  *
  * @category reducing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const reduceWhileEffect = <S, In, E, R>(
   initial: LazyArg<S>,
@@ -1395,7 +1392,7 @@ export const reduceWhileArrayEffect = <S, In, E, R>(
  * the provided `initial` state.
  *
  * @category reducing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const reduce = <S, In>(initial: LazyArg<S>, f: (s: S, input: In) => S): Sink<S, In> =>
   reduceArray(initial, (s, arr) => {
@@ -1410,7 +1407,7 @@ export const reduce = <S, In>(initial: LazyArg<S>, f: (s: S, input: In) => S): S
  * the specified `initial` state.
  *
  * @category reducing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const reduceArray = <S, In>(
   initial: LazyArg<S>,
@@ -1433,7 +1430,7 @@ export const reduceArray = <S, In>(
  * starting from the specified `initial` state.
  *
  * @category reducing
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const reduceEffect = <S, In, E, R>(
   initial: LazyArg<S>,
@@ -1492,7 +1489,7 @@ export const find: {
  * Creates a sink containing the first matching value.
  *
  * @category constructors
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const findEffect = <In, E, R>(
   predicate: (input: In) => Effect.Effect<boolean, E, R>
@@ -1528,7 +1525,7 @@ export const count: Sink<number, unknown> = reduceArray(() => 0, (s, arr) => s +
  * Accumulates incoming elements into an array.
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const collect = <In>(): Sink<Array<In>, In> =>
   reduceArray(Arr.empty<In>, (s, arr) => {
@@ -1860,7 +1857,7 @@ export const forEachWhile = <In, E, R>(
  * upstream stream ends, and completes with `void`.
  *
  * @category constructors
- * @since 2.0.0
+ * @since 4.0.0
  */
 export const forEachWhileArray = <In, E, R>(
   f: (input: NonEmptyReadonlyArray<In>) => Effect.Effect<boolean, E, R>
@@ -1971,8 +1968,8 @@ export const timed: Sink<Duration.Duration, unknown> = map(withDuration(drain),
  * Services contained in the provided context are removed from the sink's
  * service requirements.
  *
- * @category Services
- * @since 4.0.0
+ * @category services
+ * @since 2.0.0
  */
 export const provideContext: {
   /**
@@ -1981,8 +1978,8 @@ export const provideContext: {
    * Services contained in the provided context are removed from the sink's
    * service requirements.
    *
-   * @category Services
-   * @since 4.0.0
+   * @category services
+   * @since 2.0.0
    */
   <Provided>(context: Context.Context<Provided>): <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L, E, Exclude<R, Provided>>
   /**
@@ -1991,8 +1988,8 @@ export const provideContext: {
    * Services contained in the provided context are removed from the sink's
    * service requirements.
    *
-   * @category Services
-   * @since 4.0.0
+   * @category services
+   * @since 2.0.0
    */
   <A, In, L, E, R, Provided>(self: Sink<A, In, L, E, R>, context: Context.Context<Provided>): Sink<A, In, L, E, Exclude<R, Provided>>
 } = dual(2, <A, In, L, E, R, Provided>(
@@ -2011,7 +2008,7 @@ export const provideContext: {
  * The service identified by `key` is removed from the sink's service
  * requirements.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export const provideService: {
@@ -2021,7 +2018,7 @@ export const provideService: {
    * The service identified by `key` is removed from the sink's service
    * requirements.
    *
-   * @category Services
+   * @category services
    * @since 4.0.0
    */
   <I, S>(key: Context.Key<I, S>, value: Types.NoInfer<S>): <A, In, L, E, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L, E, Exclude<R, I>>
@@ -2031,7 +2028,7 @@ export const provideService: {
    * The service identified by `key` is removed from the sink's service
    * requirements.
    *
-   * @category Services
+   * @category services
    * @since 4.0.0
    */
   <A, In, L, E, R, I, S>(
@@ -2057,7 +2054,7 @@ export const provideService: {
  * upstream stream. If the upstream stream had already ended, the fallback sees
  * the upstream end instead.
  *
- * @category Error handling
+ * @category error handling
  * @since 2.0.0
  */
 export const orElse: {
@@ -2068,7 +2065,7 @@ export const orElse: {
    * upstream stream. If the upstream stream had already ended, the fallback sees
    * the upstream end instead.
    *
-   * @category Error handling
+   * @category error handling
    * @since 2.0.0
    */
   <E, A2, In2, L2, E2, R2>(f: (error: Types.NoInfer<E>) => Sink<A2, In2, L2, E2, R2>): <A, In, L, R>(self: Sink<A, In, L, E, R>) => Sink<A2 | A, In & In2, L2 | L, E2 | E, R2 | R>
@@ -2079,7 +2076,7 @@ export const orElse: {
    * upstream stream. If the upstream stream had already ended, the fallback sees
    * the upstream end instead.
    *
-   * @category Error handling
+   * @category error handling
    * @since 2.0.0
    */
   <A, In, L, E, R, A2, In2, L2, E2, R2>(self: Sink<A, In, L, E, R>, f: (error: E) => Sink<A2, In2, L2, E2, R2>): Sink<A | A2, In & In2, L | L2, E | E2, R | R2>
@@ -2115,7 +2112,7 @@ export const orElse: {
  * becomes the sink result. If the handler fails, the returned sink fails with
  * that error.
  *
- * @category Error handling
+ * @category error handling
  * @since 4.0.0
  */
 export const catchCause: {
@@ -2126,7 +2123,7 @@ export const catchCause: {
    * becomes the sink result. If the handler fails, the returned sink fails with
    * that error.
    *
-   * @category Error handling
+   * @category error handling
    * @since 4.0.0
    */
   <E, A2, E2, R2>(f: (error: Cause.Cause<Types.NoInfer<E>>) => Effect.Effect<A2, E2, R2>): <A, In, L, R>(self: Sink<A, In, L, E, R>) => Sink<A2 | A, In, L, E, R2 | R>
@@ -2137,7 +2134,7 @@ export const catchCause: {
    * becomes the sink result. If the handler fails, the returned sink fails with
    * that error.
    *
-   * @category Error handling
+   * @category error handling
    * @since 4.0.0
    */
   <A, In, L, E, R, A2, E2, R2>(
@@ -2172,7 +2169,7 @@ const catch_: {
 
 export {
   /**
-   * @category Error handling
+   * @category error handling
    * @since 4.0.0
    */
   catch_ as catch
@@ -2227,7 +2224,7 @@ export const onExit: {
  * itself fails.
  *
  * @category Finalization
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const ensuring: {
   /**
@@ -2237,7 +2234,7 @@ export const ensuring: {
    * itself fails.
    *
    * @category Finalization
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <X, E2, R2>(effect: Effect.Effect<X, E2, R2>): <A, E, In, L, R>(self: Sink<A, In, L, E, R>) => Sink<A, In, L, E | E2, R2 | R>
   /**
@@ -2247,7 +2244,7 @@ export const ensuring: {
    * itself fails.
    *
    * @category Finalization
-   * @since 4.0.0
+   * @since 2.0.0
    */
   <A, In, L, E, R, X, E2, R2>(self: Sink<A, In, L, E, R>, effect: Effect.Effect<X, E2, R2>): Sink<A, In, L, E | E2, R | R2>
 } = dual(2, <A, In, L, E, R, X, E2, R2>(

package/src/Stdio.ts

@@ -27,7 +27,7 @@ import * as Stream from "./Stream.ts"
 /**
  * String literal type used as the unique brand for the `Stdio` service.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/Stdio"
@@ -35,7 +35,7 @@ export type TypeId = "~effect/Stdio"
 /**
  * Runtime identifier stored on `Stdio` service implementations.
  *
- * @category Type IDs
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~effect/Stdio"
@@ -47,7 +47,7 @@ export const TypeId: TypeId = "~effect/Stdio"
  * error, and a stream of standard input bytes. I/O operations can fail with
  * `PlatformError`.
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export interface Stdio {
@@ -64,7 +64,7 @@ export interface Stdio {
 /**
  * Context service tag for the `Stdio` service.
  *
- * @category Services
+ * @category services
  * @since 4.0.0
  */
 export const Stdio: Context.Service<Stdio, Stdio> = Context.Service<Stdio>(TypeId)
@@ -73,7 +73,7 @@ export const Stdio: Context.Service<Stdio, Stdio> = Context.Service<Stdio>(TypeI
  * Creates a `Stdio` service implementation from the provided fields and
  * attaches the `Stdio` type identifier.
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export const make = (options: Omit<Stdio, TypeId>): Stdio => ({
@@ -88,7 +88,7 @@ export const make = (options: Omit<Stdio, TypeId>): Stdio => ({
  * standard output and error are draining sinks, and standard input is an empty
  * stream.
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerTest = (impl: Partial<Stdio>): Layer.Layer<Stdio> =>