effect 3.13.7 → 3.13.9

package/dist/dts/Stream.d.ts

@@ -255,28 +255,22 @@ export declare const aggregate: {
     <A, E, R, B, A2, E2, R2>(self: Stream<A, E, R>, sink: Sink.Sink<B, A | A2, A2, E2, R2>): Stream<B, E | E2, R | R2>;
 };
 /**
- * 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 declare 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
      */
     <B, A, A2, E2, R2, C, R3>(sink: Sink.Sink<B, A | A2, A2, E2, R2>, 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
      */
@@ -294,8 +288,6 @@ export declare 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
  */
@@ -312,8 +304,6 @@ export declare 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
      */
@@ -330,8 +320,6 @@ export declare 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
      */
@@ -2885,12 +2873,6 @@ export declare 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
  */
@@ -2978,7 +2960,10 @@ export declare const fromChunk: <A>(chunk: Chunk.Chunk<A>) => Stream<A>;
 /**
  * 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
  */
@@ -2986,7 +2971,10 @@ export declare 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
      */
@@ -2997,7 +2985,10 @@ export declare 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
      */
@@ -3009,7 +3000,10 @@ export declare 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
  */
@@ -3063,7 +3057,10 @@ export declare const fromEffectOption: <A, E, R>(effect: Effect.Effect<A, 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
  */
@@ -3071,7 +3068,10 @@ export declare 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
      */
@@ -3083,7 +3083,10 @@ export declare 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
      */
@@ -3164,8 +3167,11 @@ export declare const fromPull: <R, R2, E, A>(effect: Effect.Effect<Effect.Effect
 /**
  * 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
  */
@@ -3217,7 +3223,6 @@ export declare 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
  */
@@ -3227,7 +3232,6 @@ export declare 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
      */
@@ -3242,11 +3246,12 @@ export declare 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, allocSize?: number): Stream<Uint8Array, E>;
+    <E>(evaluate: LazyArg<ReadableStream<Uint8Array>>, onError: (error: unknown) => E, 
+    /** Controls the size of the underlying `ArrayBuffer` (defaults to `4096`) */
+    allocSize?: number): Stream<Uint8Array, E>;
 };
 /**
  * Creates a stream from a `Schedule` that does not require any further
@@ -3433,9 +3438,7 @@ export declare 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"]),
@@ -3471,9 +3474,7 @@ export declare 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"]),
@@ -3511,9 +3512,7 @@ export declare 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"]),
@@ -6853,7 +6852,6 @@ export declare 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
  */
@@ -6867,7 +6865,6 @@ export declare 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
      */
@@ -6881,7 +6878,6 @@ export declare 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
      */
@@ -7686,8 +7682,7 @@ export declare const scopedWith: <A, E, R>(f: (scope: Scope.Scope) => Effect.Eff
  * 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),
@@ -7705,8 +7700,7 @@ export declare 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),
@@ -7724,8 +7718,7 @@ export declare 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),
@@ -7817,8 +7810,7 @@ export declare 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),
@@ -7836,8 +7828,7 @@ export declare 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),
@@ -7855,8 +7846,7 @@ export declare 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),
@@ -7874,8 +7864,7 @@ export declare 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),
@@ -7893,8 +7882,7 @@ export declare 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),
@@ -10323,6 +10311,7 @@ export declare const zipWithIndex: <A, E, R>(self: Stream<A, E, R>) => Stream<[A
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -10355,6 +10344,7 @@ export declare const Do: Stream<{}>;
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -10387,6 +10377,7 @@ export declare const bind: {
      *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { Chunk, Effect, pipe, Stream } from "effect"
      *
      * const result = pipe(
@@ -10424,6 +10415,7 @@ export declare const bind: {
      *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { Chunk, Effect, pipe, Stream } from "effect"
      *
      * const result = pipe(
@@ -10509,6 +10501,7 @@ export declare const bindEffect: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -10541,6 +10534,7 @@ export declare const bindTo: {
      *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { Chunk, Effect, pipe, Stream } from "effect"
      *
      * const result = pipe(
@@ -10575,6 +10569,7 @@ export declare const bindTo: {
      *
      * @example
      * ```ts
+     * import * as assert from "node:assert"
      * import { Chunk, Effect, pipe, Stream } from "effect"
      *
      * const result = pipe(
@@ -10619,6 +10614,7 @@ export {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(