effect 3.10.18 → 3.11.0

package/dist/esm/Stream.js

@@ -33,6 +33,7 @@ export const accumulateChunks = internal.accumulateChunks;
  * stream is consumed.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * // Simulating File operations
@@ -54,6 +55,7 @@ export const accumulateChunks = internal.accumulateChunks;
  * // Opening file.txt
  * // Closing file.txt
  * // { _id: 'Chunk', values: [ [ 'Line 1', 'Line 2', 'Line 3' ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -107,12 +109,14 @@ export const aggregateWithinEither = internal.aggregateWithinEither;
  * Maps the success values of this stream to the specified constant value.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.range(1, 5).pipe(Stream.as(null))
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ null, null, null, null, null ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -129,6 +133,7 @@ export {
  * executed if the `Fiber` executing this Effect is interrupted.
  *
  * @example
+ * ```ts
  * import type { StreamEmit } from "effect"
  * import { Chunk, Effect, Option, Stream } from "effect"
  *
@@ -151,6 +156,7 @@ export {
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2 ] }
  *
+ * ```
  * @since 2.0.0
  * @category constructors
  */
@@ -179,6 +185,7 @@ export const asyncEffect = internal.asyncEffect;
  * second argument with the `bufferSize` and `strategy` fields.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * Stream.asyncPush<string>((emit) =>
@@ -193,6 +200,7 @@ export const asyncEffect = internal.asyncEffect;
  *         clearInterval(handle)
  *       })
  *   ), { bufferSize: 16, strategy: "dropping" })
+ * ```
  *
  * @since 3.6.0
  * @category constructors
@@ -223,6 +231,7 @@ export const branchAfter = internal.branchAfter;
  * chunks before the slowest downstream stream.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Fiber, Schedule, Stream } from "effect"
  *
  * const numbers = Effect.scoped(
@@ -292,6 +301,7 @@ export const branchAfter = internal.branchAfter;
  * // Logging to the Console: 19
  * // Logging to the Console: 20
  * // { _id: 'Chunk', values: [ undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -346,6 +356,7 @@ export const broadcastedQueuesDynamic = internal.broadcastedQueuesDynamic;
  *       of 2 for better performance.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Schedule, Stream } from "effect"
  *
  * const stream = Stream.range(1, 10).pipe(
@@ -372,6 +383,7 @@ export const broadcastedQueuesDynamic = internal.broadcastedQueuesDynamic;
  * // after buffering: 5
  * // before buffering: 10
  * // ...
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -442,12 +454,14 @@ export const catchSomeCause = internal.catchSomeCause;
  * elements are equal.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 1, 1, 2, 2, 3, 4).pipe(Stream.changes)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -518,6 +532,7 @@ export const combineChunks = internal.combineChunks;
  * specified stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -527,6 +542,7 @@ export const combineChunks = internal.combineChunks;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -536,6 +552,7 @@ export const concat = internal.concat;
  * Concatenates all of the streams in the chunk to one stream.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -552,6 +569,7 @@ export const concat = internal.concat;
  * //     5, 6, 7, 8
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -565,6 +583,7 @@ export const concatAll = internal.concatAll;
  * See also `Stream.zip` for the more common point-wise variant.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -579,6 +598,7 @@ export const concatAll = internal.concatAll;
  * //     [ 1, "a" ], [ 1, "b" ], [ 2, "a" ], [ 2, "b" ], [ 3, "a" ], [ 3, "b" ]
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -630,6 +650,7 @@ export const crossWith = internal.crossWith;
  * has paused typing so as to not prematurely recommend results.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * let last = Date.now()
@@ -667,6 +688,7 @@ export const crossWith = internal.crossWith;
  * // Received 8 after 1ms
  * // > Emitted 8 after 101ms
  * // { _id: 'Chunk', values: [ 3, 6, 8 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -719,6 +741,7 @@ export const distributedWithDynamic = internal.distributedWithDynamic;
  * elements. Useful for sequencing effects using streams:
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // We create a stream and immediately drain it.
@@ -726,6 +749,7 @@ export const distributedWithDynamic = internal.distributedWithDynamic;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -803,12 +827,14 @@ export const either = internal.either;
  * The empty stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.empty
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -818,6 +844,7 @@ export const empty = internal.empty;
  * Executes the provided finalizer after this stream's finalizers run.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const program = Stream.fromEffect(Console.log("Application Logic.")).pipe(
@@ -832,6 +859,7 @@ export const empty = internal.empty;
  * // Finalizing the stream
  * // Doing some other works after stream's finalization
  * // { _id: 'Chunk', values: [ undefined, undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -883,6 +911,7 @@ export const execute = internal.execute;
  * Terminates with the specified error.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.fail("Uh oh!")
@@ -893,6 +922,7 @@ export const execute = internal.execute;
  * //   _tag: 'Failure',
  * //   cause: { _id: 'Cause', _tag: 'Fail', failure: 'Uh oh!' }
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -923,12 +953,14 @@ export const failCauseSync = internal.failCauseSync;
  * Filters the elements emitted by this stream using the provided function.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.range(1, 11).pipe(Stream.filter((n) => n % 2 === 0))
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 2, 4, 6, 8, 10 ] }
+ * ```
  *
  * @since 2.0.0
  * @category filtering
@@ -976,6 +1008,7 @@ export const filterMapWhileEffect = internal.filterMapWhileEffect;
  * when it ends.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const application = Stream.fromEffect(Console.log("Application Logic."))
@@ -997,6 +1030,7 @@ export const filterMapWhileEffect = internal.filterMapWhileEffect;
  * // Deleting dir: tmp
  * // Temporary directory was deleted.
  * // { _id: 'Chunk', values: [ undefined, undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1090,6 +1124,7 @@ export const forever = internal.forever;
  * Creates a stream from an `AsyncIterable`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const myAsyncIterable = async function*() {
@@ -1104,6 +1139,7 @@ export const forever = internal.forever;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1127,6 +1163,7 @@ export const toChannel = internal.toChannel;
  * Creates a stream from a `Chunk` of values.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * // Creating a stream with values from a single Chunk
@@ -1134,6 +1171,7 @@ export const toChannel = internal.toChannel;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1159,6 +1197,7 @@ export const fromChunkQueue = internal.fromChunkQueue;
  * Creates a stream from an arbitrary number of chunks.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * // Creating a stream with values from multiple Chunks
@@ -1166,6 +1205,7 @@ export const fromChunkQueue = internal.fromChunkQueue;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1176,12 +1216,14 @@ export const fromChunks = internal.fromChunks;
  * with the failure value of this effect.
  *
  * @example
+ * ```ts
  * import { Effect, Random, Stream } from "effect"
  *
  * const stream = Stream.fromEffect(Random.nextInt)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // Example Output: { _id: 'Chunk', values: [ 922694024 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1214,6 +1256,7 @@ export const fromTPubSub = internal.fromTPubSub;
  * Creates a new `Stream` from an iterable collection of values.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const numbers = [1, 2, 3]
@@ -1222,6 +1265,7 @@ export const fromTPubSub = internal.fromTPubSub;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1231,6 +1275,7 @@ export const fromIterable = internal.fromIterable;
  * Creates a stream from an effect producing a value of type `Iterable<A>`.
  *
  * @example
+ * ```ts
  * import { Context, Effect, Stream } from "effect"
  *
  * class Database extends Context.Tag("Database")<
@@ -1246,6 +1291,7 @@ export const fromIterable = internal.fromIterable;
  * //   Stream.runCollect(stream.pipe(Stream.provideService(Database, { getUsers: Effect.succeed(["user1", "user2"]) })))
  * // ).then(console.log)
  * // { _id: 'Chunk', values: [ 'user1', 'user2' ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1308,6 +1354,7 @@ export const fromReadableStreamByob = internal.fromReadableStreamByob;
  * schedule, continuing for as long as the schedule continues.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * // Emits values every 1 second for a total of 5 emissions
@@ -1319,6 +1366,7 @@ export const fromReadableStreamByob = internal.fromReadableStreamByob;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1336,6 +1384,7 @@ export const groupAdjacentBy = internal.groupAdjacentBy;
  * More powerful version of `Stream.groupByKey`.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, GroupBy, Stream } from "effect"
  *
  * const groupByKeyResult = Stream.fromIterable([
@@ -1363,6 +1412,7 @@ export const groupAdjacentBy = internal.groupAdjacentBy;
  * //   _id: 'Chunk',
  * //   values: [ [ 'M', 1 ], [ 'J', 3 ], [ 'R', 2 ], [ 'P', 2 ] ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1410,6 +1460,7 @@ export const groupByKey = _groupBy.groupByKey;
  * Partitions the stream with specified `chunkSize`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.range(0, 8).pipe(Stream.grouped(3))
@@ -1424,6 +1475,7 @@ export const groupByKey = _groupBy.groupByKey;
  * //     [length]: 3
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1434,6 +1486,7 @@ export const grouped = internal.grouped;
  * `duration` has passed, whichever is satisfied first.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Schedule, Stream } from "effect"
  *
  * const stream = Stream.range(0, 9).pipe(
@@ -1469,6 +1522,7 @@ export const grouped = internal.grouped;
  * //     ]
  * //   }
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1522,6 +1576,7 @@ export const identity = internal.identityStream;
  * pulled.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -1531,6 +1586,7 @@ export const identity = internal.identityStream;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 4, 2, 5, 3, 6 ] }
+ * ```
  * @since 2.0.0
  * @category utils
  */
@@ -1545,6 +1601,7 @@ export const interleave = internal.interleave;
  * ignored.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 3, 5, 7, 9)
@@ -1562,6 +1619,7 @@ export const interleave = internal.interleave;
  * //     8, 5, 10, 7, 9
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1571,6 +1629,7 @@ export const interleaveWith = internal.interleaveWith;
  * Intersperse stream with provided `element`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3, 4, 5).pipe(Stream.intersperse(0))
@@ -1583,6 +1642,7 @@ export const interleaveWith = internal.interleaveWith;
  * //     0, 4, 0, 5
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1592,6 +1652,7 @@ export const intersperse = internal.intersperse;
  * Intersperse the specified element, also adding a prefix and a suffix.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3, 4, 5).pipe(
@@ -1611,6 +1672,7 @@ export const intersperse = internal.intersperse;
  * //     ']'
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1653,6 +1715,7 @@ export const interruptWhenDeferred = internal.interruptWhenDeferred;
  * f(f(f(a))), ...
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // An infinite Stream of numbers starting from 1 and incrementing
@@ -1660,6 +1723,7 @@ export const interruptWhenDeferred = internal.interruptWhenDeferred;
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(10)))).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1669,12 +1733,14 @@ export const iterate = internal.iterate;
  * Creates a stream from an sequence of values.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1684,12 +1750,14 @@ export const make = internal.make;
  * Transforms the elements of this stream using the supplied function.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3).pipe(Stream.map((n) => n + 1))
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -1699,6 +1767,7 @@ export const map = internal.map;
  * Statefully maps over the elements of this stream to produce new elements.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const runningTotal = (stream: Stream.Stream<number>): Stream.Stream<number> =>
@@ -1709,6 +1778,7 @@ export const map = internal.map;
  * //   console.log
  * // )
  * // { _id: "Chunk", values: [ 0, 1, 3, 6, 10, 15, 21 ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -1749,6 +1819,7 @@ export const mapChunksEffect = internal.mapChunksEffect;
  * output of this stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const numbers = Stream.make("1-2-3", "4-5", "6").pipe(
@@ -1758,6 +1829,7 @@ export const mapChunksEffect = internal.mapChunksEffect;
  *
  * // Effect.runPromise(Stream.runCollect(numbers)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -1791,6 +1863,7 @@ export const mapConcatEffect = internal.mapConcatEffect;
  * Maps over elements of the stream with the specified effectful function.
  *
  * @example
+ * ```ts
  * import { Effect, Random, Stream } from "effect"
  *
  * const stream = Stream.make(10, 20, 30).pipe(
@@ -1799,6 +1872,7 @@ export const mapConcatEffect = internal.mapConcatEffect;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // Example Output: { _id: 'Chunk', values: [ 7, 19, 8 ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -1825,6 +1899,7 @@ export const mapErrorCause = internal.mapErrorCause;
  * no termination strategy is specified.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3).pipe(
@@ -1838,6 +1913,7 @@ export const mapErrorCause = internal.mapErrorCause;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 4, 2, 3, 5, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1858,12 +1934,14 @@ export const mergeAll = internal.mergeAll;
  * @since 3.8.5
  *
  * @example
+ * ```ts
  * import { Stream } from "effect"
  * // Stream.Stream<{ _tag: "a"; value: number; } | { _tag: "b"; value: string; }>
  * const res = Stream.mergeWithTag({
  *    a: Stream.make(0),
  *    b: Stream.make("")
  * }, { concurrency: "unbounded" })
+ * ```
  */
 export const mergeWithTag = internal.mergeWithTag;
 /**
@@ -1874,6 +1952,7 @@ export const mergeWithTag = internal.mergeWithTag;
  * no termination strategy is specified.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make("1", "2", "3").pipe(
@@ -1890,6 +1969,7 @@ export const mergeWithTag = internal.mergeWithTag;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 4, 2, 3, 5, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1938,6 +2018,7 @@ export const never = internal.never;
  * Adds an effect to be executed at the end of the stream.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3).pipe(
@@ -1952,6 +2033,7 @@ export const never = internal.never;
  * // after mapping: 6
  * // Stream ended
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 3.6.0
  * @category sequencing
@@ -1979,6 +2061,7 @@ export const onDone = internal.onDone;
  * Adds an effect to be executed at the start of the stream.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3).pipe(
@@ -1993,6 +2076,7 @@ export const onDone = internal.onDone;
  * // after mapping: 4
  * // after mapping: 6
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 3.6.0
  * @category sequencing
@@ -2075,6 +2159,7 @@ export const orElseSucceed = internal.orElseSucceed;
  * APIs, hence the name.
  *
  * @example
+ * ```ts
  * import { Effect, Option, Stream } from "effect"
  *
  * const stream = Stream.paginate(0, (n) => [
@@ -2084,6 +2169,7 @@ export const orElseSucceed = internal.orElseSucceed;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2118,11 +2204,12 @@ export const paginateChunkEffect = internal.paginateChunkEffect;
 export const paginateEffect = internal.paginateEffect;
 /**
  * Partition a stream using a predicate. The first stream will contain all
- * element evaluated to true and the second one will contain all element
- * evaluated to false. The faster stream may advance by up to buffer elements
+ * element evaluated to false and the second one will contain all element
+ * evaluated to true. The faster stream may advance by up to buffer elements
  * further than the slower one.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const partition = Stream.range(1, 10).pipe(
@@ -2131,15 +2218,16 @@ export const paginateEffect = internal.paginateEffect;
  *
  * const program = Effect.scoped(
  *   Effect.gen(function*() {
- *     const [evens, odds] = yield* partition
- *     console.log(yield* Stream.runCollect(evens))
+ *     const [odds, evens] = yield* partition
  *     console.log(yield* Stream.runCollect(odds))
+ *     console.log(yield* Stream.runCollect(evens))
  *   })
  * )
  *
  * // Effect.runPromise(program)
- * // { _id: 'Chunk', values: [ 2, 4, 6, 8, 10 ] }
  * // { _id: 'Chunk', values: [ 1, 3, 5, 7, 9 ] }
+ * // { _id: 'Chunk', values: [ 2, 4, 6, 8, 10 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2150,6 +2238,7 @@ export const partition = internal.partition;
  * up to buffer elements further than the slower one.
  *
  * @example
+ * ```ts
  * import { Effect, Either, Stream } from "effect"
  *
  * const partition = Stream.range(1, 9).pipe(
@@ -2170,6 +2259,7 @@ export const partition = internal.partition;
  * // Effect.runPromise(program)
  * // { _id: 'Chunk', values: [ 2, 4, 6, 8 ] }
  * // { _id: 'Chunk', values: [ 1, 3, 5, 7, 9 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2278,6 +2368,7 @@ export const provideSomeLayer = internal.provideSomeLayer;
  * Any upstream failures will cause the returned stream to fail.
  *
  * @example
+ * ```ts
  * import { Stream, Schedule, Console, Effect } from "effect"
  *
  * const stream = Stream.fromSchedule(Schedule.spaced('2 millis')).pipe(
@@ -2294,6 +2385,7 @@ export const provideSomeLayer = internal.provideSomeLayer;
  * // 3
  * // 4
  * // 5
+ * ```
  * @since 3.7.0
  * @category racing
  */
@@ -2305,6 +2397,7 @@ export const race = internal.race;
  * Any upstream failures will cause the returned stream to fail.
  *
  * @example
+ * ```ts
  * import { Stream, Schedule, Console, Effect } from "effect"
  *
  * const stream = Stream.raceAll(
@@ -2321,6 +2414,7 @@ export const race = internal.race;
  * // 3
  * // 4
  * // 5
+ * ```
  * @since 3.5.0
  * @category racing
  */
@@ -2329,6 +2423,7 @@ export const raceAll = internal.raceAll;
  * Constructs a stream from a range of integers, including both endpoints.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // A Stream with a range of numbers from 1 to 5
@@ -2336,6 +2431,7 @@ export const raceAll = internal.raceAll;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2369,12 +2465,14 @@ export const refineOrDieWith = internal.refineOrDieWith;
  * execute normally, and then repeat again according to the provided schedule.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const stream = Stream.repeat(Stream.succeed(1), Schedule.forever)
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(5)))).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 1, 1, 1, 1 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2385,12 +2483,14 @@ export const repeat = internal.repeat;
  * forever.
  *
  * @example
+ * ```ts
  * import { Effect, Random, Stream } from "effect"
  *
  * const stream = Stream.repeatEffect(Random.nextInt)
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(5)))).then(console.log)
  * // Example Output: { _id: 'Chunk', values: [ 3891571149, 4239494205, 2352981603, 2339111046, 1488052210 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2417,6 +2517,7 @@ export const repeatEffectChunkOption = internal.repeatEffectChunkOption;
  * with `None`.
  *
  * @example
+ * ```ts
  * // In this example, we're draining an Iterator to create a stream from it
  * import { Stream, Effect, Option } from "effect"
  *
@@ -2431,6 +2532,7 @@ export const repeatEffectChunkOption = internal.repeatEffectChunkOption;
  *       })
  *     )
  *   )
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2484,12 +2586,14 @@ export const repeatElementsWith = internal.repeatElementsWith;
  * Repeats the provided value infinitely.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.repeatValue(0)
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(5)))).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 0, 0, 0, 0 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2733,12 +2837,14 @@ export const runSum = internal.runSum;
  * intermediate results of type `S` given an initial S.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.range(1, 6).pipe(Stream.scan(0, (a, b) => a + b))
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0,  1,  3, 6, 10, 15, 21 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2792,6 +2898,7 @@ export const scheduleWith = internal.scheduleWith;
  * Creates a single-valued stream from a scoped resource.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * // Creating a single-valued stream from a scoped resource
@@ -2808,11 +2915,21 @@ export const scheduleWith = internal.scheduleWith;
  * // use
  * // release
  * // { _id: 'Chunk', values: [ undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
  */
 export const scoped = internal.scoped;
+/**
+ * Use a function that receives a scope and returns an effect to emit an output
+ * element. The output element will be the result of the returned effect, if
+ * successful.
+ *
+ * @since 3.11.0
+ * @category constructors
+ */
+export const scopedWith = internal.scopedWith;
 /**
  * Emits a sliding window of `n` elements.
  *
@@ -2898,6 +3015,7 @@ export const splitLines = internal.splitLines;
  * Creates a single-valued pure stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // A Stream with a single number
@@ -2905,6 +3023,7 @@ export const splitLines = internal.splitLines;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2928,12 +3047,14 @@ export const suspend = internal.suspend;
  * Takes the specified number of elements from this stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.take(Stream.iterate(0, (n) => n + 1), 5)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2943,12 +3064,14 @@ export const take = internal.take;
  * Takes the last specified number of elements from this stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.takeRight(Stream.make(1, 2, 3, 4, 5, 6), 3)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 4, 5, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2959,12 +3082,14 @@ export const takeRight = internal.takeRight;
  * `true`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.takeUntil(Stream.iterate(0, (n) => n + 1), (n) => n === 4)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2983,12 +3108,14 @@ export const takeUntilEffect = internal.takeUntilEffect;
  * evaluates to `true`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.takeWhile(Stream.iterate(0, (n) => n + 1), (n) => n < 5)
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -2998,6 +3125,7 @@ export const takeWhile = internal.takeWhile;
  * Adds an effect to consumption of every element of the stream.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const stream = Stream.make(1, 2, 3).pipe(
@@ -3014,6 +3142,7 @@ export const takeWhile = internal.takeWhile;
  * // before mapping: 3
  * // after mapping: 6
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category sequencing
@@ -3064,6 +3193,7 @@ export const tapSink = internal.tapSink;
  * Defaults to the "shape" strategy.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Schedule, Stream } from "effect"
  *
  * let last = Date.now()
@@ -3099,6 +3229,7 @@ export const tapSink = internal.tapSink;
  * // Received 5 after 52ms
  * // > Emitted 5 after 49ms
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4, 5 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -3125,6 +3256,7 @@ export const throttleEffect = internal.throttleEffect;
  * A stream that emits void values spaced by the specified duration.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * let last = Date.now()
@@ -3144,6 +3276,7 @@ export const throttleEffect = internal.throttleEffect;
  * // tick after 1002ms
  * // tick after 1002ms
  * // { _id: 'Chunk', values: [ undefined, undefined, undefined, undefined, undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -3195,6 +3328,7 @@ export const toPubSub = internal.toPubSub;
  * the stream's output.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // Simulate a chunked stream
@@ -3219,6 +3353,7 @@ export const toPubSub = internal.toPubSub;
  * //   "_id": "Option",
  * //   "_tag": "None"
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category destructors
@@ -3282,12 +3417,14 @@ export const transduce = internal.transduce;
  * Creates a stream by peeling off the "layers" of a value of type `S`.
  *
  * @example
+ * ```ts
  * import { Effect, Option, Stream } from "effect"
  *
  * const stream = Stream.unfold(1, (n) => Option.some([n, n + 1]))
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(5)))).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3, 4, 5 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -3313,6 +3450,7 @@ export const unfoldChunkEffect = internal.unfoldChunkEffect;
  * `S`.
  *
  * @example
+ * ```ts
  * import { Effect, Option, Random, Stream } from "effect"
  *
  * const stream = Stream.unfoldEffect(1, (n) =>
@@ -3322,6 +3460,7 @@ export const unfoldChunkEffect = internal.unfoldChunkEffect;
  *
  * // Effect.runPromise(Stream.runCollect(stream.pipe(Stream.take(5)))).then(console.log)
  * // { _id: 'Chunk', values: [ 1, -1, -1, -1, -1 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -3333,6 +3472,7 @@ export {
  * A stream that contains a single `void` value.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.void
@@ -3340,6 +3480,7 @@ export {
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ undefined ] }
  *
+ * ```
  * @since 2.0.0
  * @category constructors
  */
@@ -3358,6 +3499,15 @@ export const unwrap = internal.unwrap;
  * @category constructors
  */
 export const unwrapScoped = internal.unwrapScoped;
+/**
+ * Creates a stream produced from a function which receives a `Scope` and
+ * returns an `Effect`. The resulting stream will emit a single element, which
+ * will be the result of the returned effect, if successful.
+ *
+ * @since 3.11.0
+ * @category constructors
+ */
+export const unwrapScopedWith = internal.unwrapScopedWith;
 /**
  * Updates the specified service within the context of the `Stream`.
  *
@@ -3411,6 +3561,7 @@ export const withSpan = internal.withSpan;
  * The new stream will end when one of the sides ends.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // We create two streams and zip them together.
@@ -3421,6 +3572,7 @@ export const withSpan = internal.withSpan;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ [ 1, 'a' ], [ 2, 'b' ], [ 3, 'c' ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3444,6 +3596,7 @@ export const zipFlatten = internal.zipFlatten;
  * have different lengths and one of the streams has ended before the other.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.zipAll(Stream.make(1, 2, 3, 4, 5, 6), {
@@ -3454,6 +3607,7 @@ export const zipFlatten = internal.zipFlatten;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: "Chunk", values: [ [ 1, "a" ], [ 2, "b" ], [ 3, "c" ], [ 4, "x" ], [ 5, "x" ], [ 6, "x" ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3547,6 +3701,7 @@ export const zipAllSortedByKeyWith = internal.zipAllSortedByKeyWith;
  * lengths and one of the streams has ended before the other.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.zipAllWith(Stream.make(1, 2, 3, 4, 5, 6), {
@@ -3558,6 +3713,7 @@ export const zipAllSortedByKeyWith = internal.zipAllSortedByKeyWith;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: "Chunk", values: [ [ 0, "a" ], [ 1, "b" ], [ 2, "c" ], [ 4, "x" ], [ 5, "x" ], [ 6, "x" ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3573,6 +3729,7 @@ export const zipAllWith = internal.zipAllWith;
  * used for zipping.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3).pipe(
@@ -3587,6 +3744,7 @@ export const zipAllWith = internal.zipAllWith;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: "Chunk", values: [ [ 1, "a" ], [ 1, "b" ], [ 2, "b" ], [ 2, "c" ], [ 2, "d" ], [ 3, "d" ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3601,6 +3759,7 @@ export const zipLatest = internal.zipLatest;
  * used for zipping.
  *
  * @example
+ * ```ts
  * import { Stream, Schedule, Console, Effect } from "effect"
  *
  * const stream = Stream.zipLatestAll(
@@ -3618,6 +3777,7 @@ export const zipLatest = internal.zipLatest;
  * // [ 3, 1, 0 ]
  * // [ 3, 1, 1 ]
  * // .....
+ * ```
  *
  * @since 3.3.0
  * @category zipping
@@ -3663,6 +3823,7 @@ export const zipRight = internal.zipRight;
  * The new stream will end when one of the sides ends.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // We create two streams and zip them with custom logic.
@@ -3674,6 +3835,7 @@ export const zipRight = internal.zipRight;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ [ 0, 'a' ], [ 1, 'b' ], [ 2, 'c' ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3693,6 +3855,7 @@ export const zipWithChunks = internal.zipWithChunks;
  * Zips each element with the next element if present.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * const stream = Stream.zipWithNext(Stream.make(1, 2, 3, 4))
@@ -3704,6 +3867,7 @@ export const zipWithChunks = internal.zipWithChunks;
  * //   [ 3, { _id: 'Option', _tag: 'Some', value: 4 } ],
  * //   [ 4, { _id: 'Option', _tag: 'None' } ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3714,6 +3878,7 @@ export const zipWithNext = internal.zipWithNext;
  * `None`.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * const stream = Stream.zipWithPrevious(Stream.make(1, 2, 3, 4))
@@ -3725,6 +3890,7 @@ export const zipWithNext = internal.zipWithNext;
  * //   [ { _id: 'Option', _tag: 'Some', value: 2 }, 3 ],
  * //   [ { _id: 'Option', _tag: 'Some', value: 3 }, 4 ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3734,6 +3900,7 @@ export const zipWithPrevious = internal.zipWithPrevious;
  * Zips each element with both the previous and next element.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * const stream = Stream.zipWithPreviousAndNext(Stream.make(1, 2, 3, 4))
@@ -3761,6 +3928,7 @@ export const zipWithPrevious = internal.zipWithPrevious;
  * //     { _id: 'Option', _tag: 'None' }
  * //   ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3770,6 +3938,7 @@ export const zipWithPreviousAndNext = internal.zipWithPreviousAndNext;
  * Zips this stream together with the index of elements.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make("Mary", "James", "Robert", "Patricia")
@@ -3781,6 +3950,7 @@ export const zipWithPreviousAndNext = internal.zipWithPreviousAndNext;
  * //   _id: 'Chunk',
  * //   values: [ [ 'Mary', 0 ], [ 'James', 1 ], [ 'Robert', 2 ], [ 'Patricia', 3 ] ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3805,6 +3975,7 @@ export const zipWithIndex = internal.zipWithIndex;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3814,6 +3985,7 @@ export const zipWithIndex = internal.zipWithIndex;
  *   Stream.let("sum", ({ x, y }) => x + y)
  * )
  * assert.deepStrictEqual(Effect.runSync(Stream.runCollect(result)), Chunk.of({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0
@@ -3835,6 +4007,7 @@ export const Do = internal.Do;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3844,6 +4017,7 @@ export const Do = internal.Do;
  *   Stream.let("sum", ({ x, y }) => x + y)
  * )
  * assert.deepStrictEqual(Effect.runSync(Stream.runCollect(result)), Chunk.of({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0
@@ -3877,6 +4051,7 @@ export const bindEffect = _groupBy.bindEffect;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3886,6 +4061,7 @@ export const bindEffect = _groupBy.bindEffect;
  *   Stream.let("sum", ({ x, y }) => x + y)
  * )
  * assert.deepStrictEqual(Effect.runSync(Stream.runCollect(result)), Chunk.of({ x: 2, y: 3, sum: 5 }))
+ * ```
  *
  * @category do notation
  * @since 2.0.0
@@ -3909,6 +4085,7 @@ export {
  * @see {@link bindEffect}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3919,6 +4096,7 @@ export {
  * )
  * assert.deepStrictEqual(Effect.runSync(Stream.runCollect(result)), Chunk.of({ x: 2, y: 3, sum: 5 }))
  *
+ * ```
  * @category do notation
  * @since 2.0.0
  */