effect 3.13.8 → 3.13.9

package/src/Stream.ts

@@ -279,19 +279,15 @@ export const aggregate: {
 } = internal.aggregate
 
 /**
- * Like `aggregateWithinEither`, but only returns the `Right` results.
+ * Like {@link aggregateWithinEither}, but only returns the `Right` results.
  *
- * @param sink A `Sink` used to perform the aggregation.
- * @param schedule A `Schedule` used to signal when to stop the aggregation.
  * @since 2.0.0
  * @category utils
  */
 export const aggregateWithin: {
   /**
-   * Like `aggregateWithinEither`, but only returns the `Right` results.
+   * Like {@link aggregateWithinEither}, but only returns the `Right` results.
    *
-   * @param sink A `Sink` used to perform the aggregation.
-   * @param schedule A `Schedule` used to signal when to stop the aggregation.
    * @since 2.0.0
    * @category utils
    */
@@ -300,10 +296,8 @@ export const aggregateWithin: {
     schedule: Schedule.Schedule<C, Option.Option<B>, R3>
   ): <E, R>(self: Stream<A, E, R>) => Stream<B, E2 | E, R2 | R3 | R>
   /**
-   * Like `aggregateWithinEither`, but only returns the `Right` results.
+   * Like {@link aggregateWithinEither}, but only returns the `Right` results.
    *
-   * @param sink A `Sink` used to perform the aggregation.
-   * @param schedule A `Schedule` used to signal when to stop the aggregation.
    * @since 2.0.0
    * @category utils
    */
@@ -326,8 +320,6 @@ export const aggregateWithin: {
  * Aggregated elements will be fed into the schedule to determine the delays
  * between pulls.
  *
- * @param sink A `Sink` used to perform the aggregation.
- * @param schedule A `Schedule` used to signal when to stop the aggregation.
  * @since 2.0.0
  * @category utils
  */
@@ -344,8 +336,6 @@ export const aggregateWithinEither: {
    * Aggregated elements will be fed into the schedule to determine the delays
    * between pulls.
    *
-   * @param sink A `Sink` used to perform the aggregation.
-   * @param schedule A `Schedule` used to signal when to stop the aggregation.
    * @since 2.0.0
    * @category utils
    */
@@ -365,8 +355,6 @@ export const aggregateWithinEither: {
    * Aggregated elements will be fed into the schedule to determine the delays
    * between pulls.
    *
-   * @param sink A `Sink` used to perform the aggregation.
-   * @param schedule A `Schedule` used to signal when to stop the aggregation.
    * @since 2.0.0
    * @category utils
    */
@@ -3124,12 +3112,6 @@ export const flattenEffect: {
 /**
  * Unwraps `Exit` values that also signify end-of-stream by failing with `None`.
  *
- * For `Exit` values that do not signal end-of-stream, prefer:
- *
- * ```ts
- * stream.mapZIO(ZIO.done(_))
- * ```
- *
  * @since 2.0.0
  * @category sequencing
  */
@@ -3233,7 +3215,10 @@ export const fromChunk: <A>(chunk: Chunk.Chunk<A>) => Stream<A> = internal.fromC
 /**
  * Creates a stream from a subscription to a `PubSub`.
  *
- * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+ * **Options**
+ *
+ * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -3241,7 +3226,10 @@ export const fromChunkPubSub: {
   /**
    * Creates a stream from a subscription to a `PubSub`.
    *
-   * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   * **Options**
+   *
+   * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   *
    * @since 2.0.0
    * @category constructors
    */
@@ -3252,7 +3240,10 @@ export const fromChunkPubSub: {
   /**
    * Creates a stream from a subscription to a `PubSub`.
    *
-   * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   * **Options**
+   *
+   * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   *
    * @since 2.0.0
    * @category constructors
    */
@@ -3265,7 +3256,10 @@ export const fromChunkPubSub: {
 /**
  * Creates a stream from a `Queue` of values.
  *
- * @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
+ * **Options**
+ *
+ * - `shutdown`: If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -3327,7 +3321,10 @@ export const fromEffectOption: <A, E, R>(effect: Effect.Effect<A, Option.Option<
 /**
  * Creates a stream from a subscription to a `PubSub`.
  *
- * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+ * **Options**
+ *
+ * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -3335,7 +3332,10 @@ export const fromPubSub: {
   /**
    * Creates a stream from a subscription to a `PubSub`.
    *
-   * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   * **Options**
+   *
+   * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   *
    * @since 2.0.0
    * @category constructors
    */
@@ -3350,7 +3350,10 @@ export const fromPubSub: {
   /**
    * Creates a stream from a subscription to a `PubSub`.
    *
-   * @param shutdown If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   * **Options**
+   *
+   * - `shutdown`: If `true`, the `PubSub` will be shutdown after the stream is evaluated (defaults to `false`)
+   *
    * @since 2.0.0
    * @category constructors
    */
@@ -3444,8 +3447,11 @@ export const fromPull: <R, R2, E, A>(
 /**
  * Creates a stream from a queue of values
  *
- * @param maxChunkSize The maximum number of queued elements to put in one chunk in the stream
- * @param shutdown If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
+ * **Options**
+ *
+ * - `maxChunkSize`: The maximum number of queued elements to put in one chunk in the stream
+ * - `shutdown`: If `true`, the queue will be shutdown after the stream is evaluated (defaults to `false`)
+ *
  * @since 2.0.0
  * @category constructors
  */
@@ -3505,7 +3511,6 @@ export const fromReadableStream: {
  *
  * See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader.
  *
- * @param allocSize Controls the size of the underlying `ArrayBuffer` (defaults to `4096`).
  * @since 2.0.0
  * @category constructors
  */
@@ -3515,7 +3520,6 @@ export const fromReadableStreamByob: {
    *
    * See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader.
    *
-   * @param allocSize Controls the size of the underlying `ArrayBuffer` (defaults to `4096`).
    * @since 2.0.0
    * @category constructors
    */
@@ -3532,13 +3536,13 @@ export const fromReadableStreamByob: {
    *
    * See https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader.
    *
-   * @param allocSize Controls the size of the underlying `ArrayBuffer` (defaults to `4096`).
    * @since 2.0.0
    * @category constructors
    */
   <E>(
     evaluate: LazyArg<ReadableStream<Uint8Array>>,
     onError: (error: unknown) => E,
+    /** Controls the size of the underlying `ArrayBuffer` (defaults to `4096`) */
     allocSize?: number
   ): Stream<Uint8Array, E>
 } = internal.fromReadableStreamByob
@@ -3735,9 +3739,7 @@ export const groupBy: {
  * stream of words:
  *
  * ```ts
- * import * as GroupBy from "./GroupBy"
- * import * as Stream from "./Stream"
- * import { pipe } from "./Function"
+ * import { pipe, GroupBy, Stream } from "effect"
  *
  * pipe(
  *   Stream.fromIterable(["hello", "world", "hi", "holla"]),
@@ -3773,9 +3775,7 @@ export const groupByKey: {
    * stream of words:
    *
    * ```ts
-   * import * as GroupBy from "./GroupBy"
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, GroupBy, Stream } from "effect"
    *
    * pipe(
    *   Stream.fromIterable(["hello", "world", "hi", "holla"]),
@@ -3816,9 +3816,7 @@ export const groupByKey: {
    * stream of words:
    *
    * ```ts
-   * import * as GroupBy from "./GroupBy"
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, GroupBy, Stream } from "effect"
    *
    * pipe(
    *   Stream.fromIterable(["hello", "world", "hi", "holla"]),
@@ -7337,7 +7335,6 @@ export const repeatWith: {
  * The schedule is reset as soon as the first element passes through the
  * stream again.
  *
- * @param schedule A `Schedule` receiving as input the errors of the stream.
  * @since 2.0.0
  * @category utils
  */
@@ -7351,7 +7348,6 @@ export const retry: {
    * The schedule is reset as soon as the first element passes through the
    * stream again.
    *
-   * @param schedule A `Schedule` receiving as input the errors of the stream.
    * @since 2.0.0
    * @category utils
    */
@@ -7365,7 +7361,6 @@ export const retry: {
    * The schedule is reset as soon as the first element passes through the
    * stream again.
    *
-   * @param schedule A `Schedule` receiving as input the errors of the stream.
    * @since 2.0.0
    * @category utils
    */
@@ -8225,8 +8220,7 @@ export const scopedWith: <A, E, R>(f: (scope: Scope.Scope) => Effect.Effect<A, E
  * Emits a sliding window of `n` elements.
  *
  * ```ts
- * import * as Stream from "./Stream"
- * import { pipe } from "./Function"
+ * import { pipe, Stream } from "effect"
  *
  * pipe(
  *   Stream.make(1, 2, 3, 4),
@@ -8244,8 +8238,7 @@ export const sliding: {
    * Emits a sliding window of `n` elements.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.make(1, 2, 3, 4),
@@ -8263,8 +8256,7 @@ export const sliding: {
    * Emits a sliding window of `n` elements.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.make(1, 2, 3, 4),
@@ -8361,8 +8353,7 @@ export const someOrFail: {
  * Splits elements based on a predicate or refinement.
  *
  * ```ts
- * import * as Stream from "./Stream"
- * import { pipe } from "./Function"
+ * import { pipe, Stream } from "effect"
  *
  * pipe(
  *   Stream.range(1, 10),
@@ -8380,8 +8371,7 @@ export const split: {
    * Splits elements based on a predicate or refinement.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.range(1, 10),
@@ -8399,8 +8389,7 @@ export const split: {
    * Splits elements based on a predicate or refinement.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.range(1, 10),
@@ -8418,8 +8407,7 @@ export const split: {
    * Splits elements based on a predicate or refinement.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.range(1, 10),
@@ -8437,8 +8425,7 @@ export const split: {
    * Splits elements based on a predicate or refinement.
    *
    * ```ts
-   * import * as Stream from "./Stream"
-   * import { pipe } from "./Function"
+   * import { pipe, Stream } from "effect"
    *
    * pipe(
    *   Stream.range(1, 10),
@@ -11049,6 +11036,7 @@ export const zipWithIndex: <A, E, R>(self: Stream<A, E, R>) => Stream<[A, number
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -11082,6 +11070,7 @@ export const Do: Stream<{}> = internal.Do
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -11114,6 +11103,7 @@ export const bind: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk, Effect, pipe, Stream } from "effect"
    *
    * const result = pipe(
@@ -11152,6 +11142,7 @@ export const bind: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk, Effect, pipe, Stream } from "effect"
    *
    * const result = pipe(
@@ -11240,6 +11231,7 @@ export const bindEffect: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -11272,6 +11264,7 @@ export const bindTo: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk, Effect, pipe, Stream } from "effect"
    *
    * const result = pipe(
@@ -11304,6 +11297,7 @@ export const bindTo: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk, Effect, pipe, Stream } from "effect"
    *
    * const result = pipe(
@@ -11351,6 +11345,7 @@ export {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Chunk, Effect, pipe, Stream } from "effect"
    *
    * const result = pipe(