effect 3.10.18 → 3.11.0

package/dist/cjs/Stream.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.fromIterableEffect = exports.fromIterable = exports.fromEventListener = exports.fromEffectOption = exports.fromEffect = exports.fromChunks = exports.fromChunkQueue = exports.fromChunkPubSub = exports.fromChunk = exports.fromChannel = exports.fromAsyncIterable = exports.forever = exports.flattenTake = exports.flattenIterables = exports.flattenExitOption = exports.flattenEffect = exports.flattenChunks = exports.flatten = exports.flatMap = exports.findEffect = exports.find = exports.finalizer = exports.filterMapWhileEffect = exports.filterMapWhile = exports.filterMapEffect = exports.filterMap = exports.filterEffect = exports.filter = exports.failSync = exports.failCauseSync = exports.failCause = exports.fail = exports.execute = exports.ensuringWith = exports.ensuring = exports.encodeText = exports.empty = exports.either = exports.dropWhileEffect = exports.dropWhile = exports.dropUntilEffect = exports.dropUntil = exports.dropRight = exports.drop = exports.drainFork = exports.drain = exports.distributedWithDynamic = exports.distributedWith = exports.dieSync = exports.dieMessage = exports.die = exports.decodeText = exports.debounce = exports.crossWith = exports.crossRight = exports.crossLeft = exports.cross = exports.contextWithStream = exports.contextWithEffect = exports.contextWith = exports.context = exports.concatAll = exports.concat = exports.combineChunks = exports.combine = exports.chunksWith = exports.chunks = exports.changesWithEffect = exports.changesWith = exports.changes = exports.catchTags = exports.catchTag = exports.catchSomeCause = exports.catchSome = exports.catchAllCause = exports.catchAll = exports.bufferChunks = exports.buffer = exports.broadcastedQueuesDynamic = exports.broadcastedQueues = exports.broadcastDynamic = exports.broadcast = exports.branchAfter = exports.bindTo = exports.bindEffect = exports.bind = exports.asyncScoped = exports.asyncPush = exports.asyncEffect = exports.async = exports.as = exports.aggregateWithinEither = exports.aggregateWithin = exports.aggregate = exports.acquireRelease = exports.accumulateChunks = exports.accumulate = exports.StreamTypeId = exports.Do = exports.DefaultChunkSize = void 0;
 exports.run = exports.retry = exports.repeatWith = exports.repeatValue = exports.repeatElementsWith = exports.repeatElements = exports.repeatEither = exports.repeatEffectWithSchedule = exports.repeatEffectOption = exports.repeatEffectChunkOption = exports.repeatEffectChunk = exports.repeatEffect = exports.repeat = exports.refineOrDieWith = exports.refineOrDie = exports.rechunk = exports.range = exports.raceAll = exports.race = exports.provideSomeLayer = exports.provideServiceStream = exports.provideServiceEffect = exports.provideService = exports.provideLayer = exports.provideContext = exports.prepend = exports.pipeThroughChannelOrFail = exports.pipeThroughChannel = exports.pipeThrough = exports.peel = exports.partitionEither = exports.partition = exports.paginateEffect = exports.paginateChunkEffect = exports.paginateChunk = exports.paginate = exports.orElseSucceed = exports.orElseIfEmptyStream = exports.orElseIfEmptyChunk = exports.orElseIfEmpty = exports.orElseFail = exports.orElseEither = exports.orElse = exports.orDieWith = exports.orDie = exports.onStart = exports.onError = exports.onEnd = exports.onDone = exports.never = exports.mkString = exports.mergeWithTag = exports.mergeWith = exports.mergeRight = exports.mergeLeft = exports.mergeEither = exports.mergeAll = exports.merge = exports.mapInputContext = exports.mapErrorCause = exports.mapError = exports.mapEffect = exports.mapConcatEffect = exports.mapConcatChunkEffect = exports.mapConcatChunk = exports.mapConcat = exports.mapChunksEffect = exports.mapChunks = exports.mapBoth = exports.mapAccumEffect = exports.mapAccum = exports.map = exports.make = exports.let = exports.iterate = exports.intersperseAffixes = exports.intersperse = exports.interruptWhenDeferred = exports.interruptWhen = exports.interruptAfter = exports.interleaveWith = exports.interleave = exports.identity = exports.haltWhenDeferred = exports.haltWhen = exports.haltAfter = exports.groupedWithin = exports.grouped = exports.groupByKey = exports.groupBy = exports.groupAdjacentBy = exports.fromTQueue = exports.fromTPubSub = exports.fromSchedule = exports.fromReadableStreamByob = exports.fromReadableStream = exports.fromQueue = exports.fromPull = exports.fromPubSub = exports.fromIteratorSucceed = void 0;
-exports.zipWith = exports.zipRight = exports.zipLeft = exports.zipLatestWith = exports.zipLatestAll = exports.zipLatest = exports.zipFlatten = exports.zipAllWith = exports.zipAllSortedByKeyWith = exports.zipAllSortedByKeyRight = exports.zipAllSortedByKeyLeft = exports.zipAllSortedByKey = exports.zipAllRight = exports.zipAllLeft = exports.zipAll = exports.zip = exports.withSpan = exports.whenEffect = exports.whenCaseEffect = exports.whenCase = exports.when = exports.void = exports.updateService = exports.unwrapScoped = exports.unwrap = exports.unfoldEffect = exports.unfoldChunkEffect = exports.unfoldChunk = exports.unfold = exports.transduce = exports.toReadableStreamRuntime = exports.toReadableStreamEffect = exports.toReadableStream = exports.toQueueOfElements = exports.toQueue = exports.toPull = exports.toPubSub = exports.toChannel = exports.timeoutTo = exports.timeoutFailCause = exports.timeoutFail = exports.timeout = exports.tick = exports.throttleEffect = exports.throttle = exports.tapSink = exports.tapErrorCause = exports.tapError = exports.tapBoth = exports.tap = exports.takeWhile = exports.takeUntilEffect = exports.takeUntil = exports.takeRight = exports.take = exports.sync = exports.suspend = exports.succeed = exports.splitOnChunk = exports.splitLines = exports.split = exports.someOrFail = exports.someOrElse = exports.some = exports.slidingSize = exports.sliding = exports.share = exports.scoped = exports.scheduleWith = exports.schedule = exports.scanReduceEffect = exports.scanReduce = exports.scanEffect = exports.scan = exports.runSum = exports.runScoped = exports.runLast = exports.runIntoQueueScoped = exports.runIntoQueueElementsScoped = exports.runIntoQueue = exports.runIntoPubSubScoped = exports.runIntoPubSub = exports.runHead = exports.runForEachWhileScoped = exports.runForEachWhile = exports.runForEachScoped = exports.runForEachChunkScoped = exports.runForEachChunk = exports.runForEach = exports.runFoldWhileScopedEffect = exports.runFoldWhileScoped = exports.runFoldWhileEffect = exports.runFoldWhile = exports.runFoldScopedEffect = exports.runFoldScoped = exports.runFoldEffect = exports.runFold = exports.runDrain = exports.runCount = exports.runCollect = void 0;
-exports.zipWithPreviousAndNext = exports.zipWithPrevious = exports.zipWithNext = exports.zipWithIndex = exports.zipWithChunks = void 0;
+exports.zipLeft = exports.zipLatestWith = exports.zipLatestAll = exports.zipLatest = exports.zipFlatten = exports.zipAllWith = exports.zipAllSortedByKeyWith = exports.zipAllSortedByKeyRight = exports.zipAllSortedByKeyLeft = exports.zipAllSortedByKey = exports.zipAllRight = exports.zipAllLeft = exports.zipAll = exports.zip = exports.withSpan = exports.whenEffect = exports.whenCaseEffect = exports.whenCase = exports.when = exports.void = exports.updateService = exports.unwrapScopedWith = exports.unwrapScoped = exports.unwrap = exports.unfoldEffect = exports.unfoldChunkEffect = exports.unfoldChunk = exports.unfold = exports.transduce = exports.toReadableStreamRuntime = exports.toReadableStreamEffect = exports.toReadableStream = exports.toQueueOfElements = exports.toQueue = exports.toPull = exports.toPubSub = exports.toChannel = exports.timeoutTo = exports.timeoutFailCause = exports.timeoutFail = exports.timeout = exports.tick = exports.throttleEffect = exports.throttle = exports.tapSink = exports.tapErrorCause = exports.tapError = exports.tapBoth = exports.tap = exports.takeWhile = exports.takeUntilEffect = exports.takeUntil = exports.takeRight = exports.take = exports.sync = exports.suspend = exports.succeed = exports.splitOnChunk = exports.splitLines = exports.split = exports.someOrFail = exports.someOrElse = exports.some = exports.slidingSize = exports.sliding = exports.share = exports.scopedWith = exports.scoped = exports.scheduleWith = exports.schedule = exports.scanReduceEffect = exports.scanReduce = exports.scanEffect = exports.scan = exports.runSum = exports.runScoped = exports.runLast = exports.runIntoQueueScoped = exports.runIntoQueueElementsScoped = exports.runIntoQueue = exports.runIntoPubSubScoped = exports.runIntoPubSub = exports.runHead = exports.runForEachWhileScoped = exports.runForEachWhile = exports.runForEachScoped = exports.runForEachChunkScoped = exports.runForEachChunk = exports.runForEach = exports.runFoldWhileScopedEffect = exports.runFoldWhileScoped = exports.runFoldWhileEffect = exports.runFoldWhile = exports.runFoldScopedEffect = exports.runFoldScoped = exports.runFoldEffect = exports.runFold = exports.runDrain = exports.runCount = exports.runCollect = void 0;
+exports.zipWithPreviousAndNext = exports.zipWithPrevious = exports.zipWithNext = exports.zipWithIndex = exports.zipWithChunks = exports.zipWith = exports.zipRight = void 0;
 var _groupBy = _interopRequireWildcard(require("./internal/groupBy.js"));
 var internal = _interopRequireWildcard(require("./internal/stream.js"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
@@ -44,6 +44,7 @@ const accumulateChunks = exports.accumulateChunks = internal.accumulateChunks;
  * stream is consumed.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * // Simulating File operations
@@ -65,6 +66,7 @@ const accumulateChunks = exports.accumulateChunks = internal.accumulateChunks;
  * // Opening file.txt
  * // Closing file.txt
  * // { _id: 'Chunk', values: [ [ 'Line 1', 'Line 2', 'Line 3' ] ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -118,12 +120,14 @@ const aggregateWithinEither = exports.aggregateWithinEither = internal.aggregate
  * 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
@@ -154,6 +158,7 @@ const asyncEffect = exports.asyncEffect = internal.asyncEffect;
  * second argument with the `bufferSize` and `strategy` fields.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * Stream.asyncPush<string>((emit) =>
@@ -168,6 +173,7 @@ const asyncEffect = exports.asyncEffect = internal.asyncEffect;
  *         clearInterval(handle)
  *       })
  *   ), { bufferSize: 16, strategy: "dropping" })
+ * ```
  *
  * @since 3.6.0
  * @category constructors
@@ -198,6 +204,7 @@ const branchAfter = exports.branchAfter = internal.branchAfter;
  * chunks before the slowest downstream stream.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Fiber, Schedule, Stream } from "effect"
  *
  * const numbers = Effect.scoped(
@@ -267,6 +274,7 @@ const branchAfter = exports.branchAfter = internal.branchAfter;
  * // Logging to the Console: 19
  * // Logging to the Console: 20
  * // { _id: 'Chunk', values: [ undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -321,6 +329,7 @@ const broadcastedQueuesDynamic = exports.broadcastedQueuesDynamic = internal.bro
  *       of 2 for better performance.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Schedule, Stream } from "effect"
  *
  * const stream = Stream.range(1, 10).pipe(
@@ -347,6 +356,7 @@ const broadcastedQueuesDynamic = exports.broadcastedQueuesDynamic = internal.bro
  * // after buffering: 5
  * // before buffering: 10
  * // ...
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -417,12 +427,14 @@ const catchSomeCause = exports.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
@@ -493,6 +505,7 @@ const combineChunks = exports.combineChunks = internal.combineChunks;
  * specified stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -502,6 +515,7 @@ const combineChunks = exports.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
@@ -511,6 +525,7 @@ const concat = exports.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)
@@ -527,6 +542,7 @@ const concat = exports.concat = internal.concat;
  * //     5, 6, 7, 8
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -540,6 +556,7 @@ const concatAll = exports.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)
@@ -554,6 +571,7 @@ const concatAll = exports.concatAll = internal.concatAll;
  * //     [ 1, "a" ], [ 1, "b" ], [ 2, "a" ], [ 2, "b" ], [ 3, "a" ], [ 3, "b" ]
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -605,6 +623,7 @@ const crossWith = exports.crossWith = internal.crossWith;
  * has paused typing so as to not prematurely recommend results.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * let last = Date.now()
@@ -642,6 +661,7 @@ const crossWith = exports.crossWith = internal.crossWith;
  * // Received 8 after 1ms
  * // > Emitted 8 after 101ms
  * // { _id: 'Chunk', values: [ 3, 6, 8 ] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -694,6 +714,7 @@ const distributedWithDynamic = exports.distributedWithDynamic = internal.distrib
  * elements. Useful for sequencing effects using streams:
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // We create a stream and immediately drain it.
@@ -701,6 +722,7 @@ const distributedWithDynamic = exports.distributedWithDynamic = internal.distrib
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [] }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -778,12 +800,14 @@ const either = exports.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
@@ -793,6 +817,7 @@ const empty = exports.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(
@@ -807,6 +832,7 @@ const empty = exports.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
@@ -858,6 +884,7 @@ const execute = exports.execute = internal.execute;
  * Terminates with the specified error.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.fail("Uh oh!")
@@ -868,6 +895,7 @@ const execute = exports.execute = internal.execute;
  * //   _tag: 'Failure',
  * //   cause: { _id: 'Cause', _tag: 'Fail', failure: 'Uh oh!' }
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -898,12 +926,14 @@ const failCauseSync = exports.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
@@ -951,6 +981,7 @@ const filterMapWhileEffect = exports.filterMapWhileEffect = internal.filterMapWh
  * when it ends.
  *
  * @example
+ * ```ts
  * import { Console, Effect, Stream } from "effect"
  *
  * const application = Stream.fromEffect(Console.log("Application Logic."))
@@ -972,6 +1003,7 @@ const filterMapWhileEffect = exports.filterMapWhileEffect = internal.filterMapWh
  * // Deleting dir: tmp
  * // Temporary directory was deleted.
  * // { _id: 'Chunk', values: [ undefined, undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1065,6 +1097,7 @@ const forever = exports.forever = internal.forever;
  * Creates a stream from an `AsyncIterable`.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const myAsyncIterable = async function*() {
@@ -1079,6 +1112,7 @@ const forever = exports.forever = internal.forever;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1102,6 +1136,7 @@ const toChannel = exports.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
@@ -1109,6 +1144,7 @@ const toChannel = exports.toChannel = internal.toChannel;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1134,6 +1170,7 @@ const fromChunkQueue = exports.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
@@ -1141,6 +1178,7 @@ const fromChunkQueue = exports.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
@@ -1151,12 +1189,14 @@ const fromChunks = exports.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
@@ -1189,6 +1229,7 @@ const fromTPubSub = exports.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]
@@ -1197,6 +1238,7 @@ const fromTPubSub = exports.fromTPubSub = internal.fromTPubSub;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1206,6 +1248,7 @@ const fromIterable = exports.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")<
@@ -1221,6 +1264,7 @@ const fromIterable = exports.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
@@ -1283,6 +1327,7 @@ const fromReadableStreamByob = exports.fromReadableStreamByob = internal.fromRea
  * 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
@@ -1294,6 +1339,7 @@ const fromReadableStreamByob = exports.fromReadableStreamByob = internal.fromRea
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3, 4 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -1311,6 +1357,7 @@ const groupAdjacentBy = exports.groupAdjacentBy = internal.groupAdjacentBy;
  * More powerful version of `Stream.groupByKey`.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, GroupBy, Stream } from "effect"
  *
  * const groupByKeyResult = Stream.fromIterable([
@@ -1338,6 +1385,7 @@ const groupAdjacentBy = exports.groupAdjacentBy = internal.groupAdjacentBy;
  * //   _id: 'Chunk',
  * //   values: [ [ 'M', 1 ], [ 'J', 3 ], [ 'R', 2 ], [ 'P', 2 ] ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1385,6 +1433,7 @@ const groupByKey = exports.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))
@@ -1399,6 +1448,7 @@ const groupByKey = exports.groupByKey = _groupBy.groupByKey;
  * //     [length]: 3
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1409,6 +1459,7 @@ const grouped = exports.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(
@@ -1444,6 +1495,7 @@ const grouped = exports.grouped = internal.grouped;
  * //     ]
  * //   }
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category grouping
@@ -1497,6 +1549,7 @@ const identity = exports.identity = internal.identityStream;
  * pulled.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3)
@@ -1506,6 +1559,7 @@ const identity = exports.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
  */
@@ -1520,6 +1574,7 @@ const interleave = exports.interleave = internal.interleave;
  * ignored.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 3, 5, 7, 9)
@@ -1537,6 +1592,7 @@ const interleave = exports.interleave = internal.interleave;
  * //     8, 5, 10, 7, 9
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1546,6 +1602,7 @@ const interleaveWith = exports.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))
@@ -1558,6 +1615,7 @@ const interleaveWith = exports.interleaveWith = internal.interleaveWith;
  * //     0, 4, 0, 5
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1567,6 +1625,7 @@ const intersperse = exports.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(
@@ -1586,6 +1645,7 @@ const intersperse = exports.intersperse = internal.intersperse;
  * //     ']'
  * //   ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category utils
@@ -1628,6 +1688,7 @@ const interruptWhenDeferred = exports.interruptWhenDeferred = internal.interrupt
  * f(f(f(a))), ...
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // An infinite Stream of numbers starting from 1 and incrementing
@@ -1635,6 +1696,7 @@ const interruptWhenDeferred = exports.interruptWhenDeferred = internal.interrupt
  *
  * // 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
@@ -1644,12 +1706,14 @@ const iterate = exports.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
@@ -1659,12 +1723,14 @@ const make = exports.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
@@ -1674,6 +1740,7 @@ const map = exports.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> =>
@@ -1684,6 +1751,7 @@ const map = exports.map = internal.map;
  * //   console.log
  * // )
  * // { _id: "Chunk", values: [ 0, 1, 3, 6, 10, 15, 21 ] }
+ * ```
  *
  * @since 2.0.0
  * @category mapping
@@ -1724,6 +1792,7 @@ const mapChunksEffect = exports.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(
@@ -1733,6 +1802,7 @@ const mapChunksEffect = exports.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
@@ -1766,6 +1836,7 @@ const mapConcatEffect = exports.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(
@@ -1774,6 +1845,7 @@ const mapConcatEffect = exports.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
@@ -1800,6 +1872,7 @@ const mapErrorCause = exports.mapErrorCause = internal.mapErrorCause;
  * no termination strategy is specified.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3).pipe(
@@ -1813,6 +1886,7 @@ const mapErrorCause = exports.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
@@ -1833,12 +1907,14 @@ const mergeAll = exports.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" })
+ * ```
  */
 const mergeWithTag = exports.mergeWithTag = internal.mergeWithTag;
 /**
@@ -1849,6 +1925,7 @@ const mergeWithTag = exports.mergeWithTag = internal.mergeWithTag;
  * no termination strategy is specified.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make("1", "2", "3").pipe(
@@ -1865,6 +1942,7 @@ const mergeWithTag = exports.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
@@ -1913,6 +1991,7 @@ const never = exports.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(
@@ -1927,6 +2006,7 @@ const never = exports.never = internal.never;
  * // after mapping: 6
  * // Stream ended
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 3.6.0
  * @category sequencing
@@ -1954,6 +2034,7 @@ const onDone = exports.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(
@@ -1968,6 +2049,7 @@ const onDone = exports.onDone = internal.onDone;
  * // after mapping: 4
  * // after mapping: 6
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 3.6.0
  * @category sequencing
@@ -2050,6 +2132,7 @@ const orElseSucceed = exports.orElseSucceed = internal.orElseSucceed;
  * APIs, hence the name.
  *
  * @example
+ * ```ts
  * import { Effect, Option, Stream } from "effect"
  *
  * const stream = Stream.paginate(0, (n) => [
@@ -2059,6 +2142,7 @@ const orElseSucceed = exports.orElseSucceed = internal.orElseSucceed;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 0, 1, 2, 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2093,11 +2177,12 @@ const paginateChunkEffect = exports.paginateChunkEffect = internal.paginateChunk
 const paginateEffect = exports.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(
@@ -2106,15 +2191,16 @@ const paginateEffect = exports.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
@@ -2125,6 +2211,7 @@ const partition = exports.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(
@@ -2145,6 +2232,7 @@ const partition = exports.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
@@ -2253,6 +2341,7 @@ const provideSomeLayer = exports.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(
@@ -2269,6 +2358,7 @@ const provideSomeLayer = exports.provideSomeLayer = internal.provideSomeLayer;
  * // 3
  * // 4
  * // 5
+ * ```
  * @since 3.7.0
  * @category racing
  */
@@ -2280,6 +2370,7 @@ const race = exports.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(
@@ -2296,6 +2387,7 @@ const race = exports.race = internal.race;
  * // 3
  * // 4
  * // 5
+ * ```
  * @since 3.5.0
  * @category racing
  */
@@ -2304,6 +2396,7 @@ const raceAll = exports.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
@@ -2311,6 +2404,7 @@ const raceAll = exports.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
@@ -2344,12 +2438,14 @@ const refineOrDieWith = exports.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
@@ -2360,12 +2456,14 @@ const repeat = exports.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
@@ -2392,6 +2490,7 @@ const repeatEffectChunkOption = exports.repeatEffectChunkOption = internal.repea
  * with `None`.
  *
  * @example
+ * ```ts
  * // In this example, we're draining an Iterator to create a stream from it
  * import { Stream, Effect, Option } from "effect"
  *
@@ -2406,6 +2505,7 @@ const repeatEffectChunkOption = exports.repeatEffectChunkOption = internal.repea
  *       })
  *     )
  *   )
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2459,12 +2559,14 @@ const repeatElementsWith = exports.repeatElementsWith = internal.repeatElementsW
  * 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
@@ -2708,12 +2810,14 @@ const runSum = exports.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
@@ -2767,6 +2871,7 @@ const scheduleWith = exports.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
@@ -2783,11 +2888,21 @@ const scheduleWith = exports.scheduleWith = internal.scheduleWith;
  * // use
  * // release
  * // { _id: 'Chunk', values: [ undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
  */
 const scoped = exports.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
+ */
+const scopedWith = exports.scopedWith = internal.scopedWith;
 /**
  * Emits a sliding window of `n` elements.
  *
@@ -2873,6 +2988,7 @@ const splitLines = exports.splitLines = internal.splitLines;
  * Creates a single-valued pure stream.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // A Stream with a single number
@@ -2880,6 +2996,7 @@ const splitLines = exports.splitLines = internal.splitLines;
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)
  * // { _id: 'Chunk', values: [ 3 ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -2903,12 +3020,14 @@ const suspend = exports.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
@@ -2918,12 +3037,14 @@ const take = exports.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
@@ -2934,12 +3055,14 @@ const takeRight = exports.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
@@ -2958,12 +3081,14 @@ const takeUntilEffect = exports.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
@@ -2973,6 +3098,7 @@ const takeWhile = exports.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(
@@ -2989,6 +3115,7 @@ const takeWhile = exports.takeWhile = internal.takeWhile;
  * // before mapping: 3
  * // after mapping: 6
  * // { _id: 'Chunk', values: [ 2, 4, 6 ] }
+ * ```
  *
  * @since 2.0.0
  * @category sequencing
@@ -3039,6 +3166,7 @@ const tapSink = exports.tapSink = internal.tapSink;
  * Defaults to the "shape" strategy.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Schedule, Stream } from "effect"
  *
  * let last = Date.now()
@@ -3074,6 +3202,7 @@ const tapSink = exports.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
@@ -3100,6 +3229,7 @@ const throttleEffect = exports.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()
@@ -3119,6 +3249,7 @@ const throttleEffect = exports.throttleEffect = internal.throttleEffect;
  * // tick after 1002ms
  * // tick after 1002ms
  * // { _id: 'Chunk', values: [ undefined, undefined, undefined, undefined, undefined ] }
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -3170,6 +3301,7 @@ const toPubSub = exports.toPubSub = internal.toPubSub;
  * the stream's output.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * // Simulate a chunked stream
@@ -3194,6 +3326,7 @@ const toPubSub = exports.toPubSub = internal.toPubSub;
  * //   "_id": "Option",
  * //   "_tag": "None"
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category destructors
@@ -3257,12 +3390,14 @@ const transduce = exports.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
@@ -3288,6 +3423,7 @@ const unfoldChunkEffect = exports.unfoldChunkEffect = internal.unfoldChunkEffect
  * `S`.
  *
  * @example
+ * ```ts
  * import { Effect, Option, Random, Stream } from "effect"
  *
  * const stream = Stream.unfoldEffect(1, (n) =>
@@ -3297,6 +3433,7 @@ const unfoldChunkEffect = exports.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
@@ -3317,6 +3454,15 @@ const unwrap = exports.unwrap = internal.unwrap;
  * @category constructors
  */
 const unwrapScoped = exports.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
+ */
+const unwrapScopedWith = exports.unwrapScopedWith = internal.unwrapScopedWith;
 /**
  * Updates the specified service within the context of the `Stream`.
  *
@@ -3370,6 +3516,7 @@ const withSpan = exports.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.
@@ -3380,6 +3527,7 @@ const withSpan = exports.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
@@ -3403,6 +3551,7 @@ const zipFlatten = exports.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), {
@@ -3413,6 +3562,7 @@ const zipFlatten = exports.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
@@ -3506,6 +3656,7 @@ const zipAllSortedByKeyWith = exports.zipAllSortedByKeyWith = internal.zipAllSor
  * 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), {
@@ -3517,6 +3668,7 @@ const zipAllSortedByKeyWith = exports.zipAllSortedByKeyWith = internal.zipAllSor
  *
  * // 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
@@ -3532,6 +3684,7 @@ const zipAllWith = exports.zipAllWith = internal.zipAllWith;
  * used for zipping.
  *
  * @example
+ * ```ts
  * import { Effect, Schedule, Stream } from "effect"
  *
  * const s1 = Stream.make(1, 2, 3).pipe(
@@ -3546,6 +3699,7 @@ const zipAllWith = exports.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
@@ -3560,6 +3714,7 @@ const zipLatest = exports.zipLatest = internal.zipLatest;
  * used for zipping.
  *
  * @example
+ * ```ts
  * import { Stream, Schedule, Console, Effect } from "effect"
  *
  * const stream = Stream.zipLatestAll(
@@ -3577,6 +3732,7 @@ const zipLatest = exports.zipLatest = internal.zipLatest;
  * // [ 3, 1, 0 ]
  * // [ 3, 1, 1 ]
  * // .....
+ * ```
  *
  * @since 3.3.0
  * @category zipping
@@ -3622,6 +3778,7 @@ const zipRight = exports.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.
@@ -3633,6 +3790,7 @@ const zipRight = exports.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
@@ -3652,6 +3810,7 @@ const zipWithChunks = exports.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))
@@ -3663,6 +3822,7 @@ const zipWithChunks = exports.zipWithChunks = internal.zipWithChunks;
  * //   [ 3, { _id: 'Option', _tag: 'Some', value: 4 } ],
  * //   [ 4, { _id: 'Option', _tag: 'None' } ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3673,6 +3833,7 @@ const zipWithNext = exports.zipWithNext = internal.zipWithNext;
  * `None`.
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, Stream } from "effect"
  *
  * const stream = Stream.zipWithPrevious(Stream.make(1, 2, 3, 4))
@@ -3684,6 +3845,7 @@ const zipWithNext = exports.zipWithNext = internal.zipWithNext;
  * //   [ { _id: 'Option', _tag: 'Some', value: 2 }, 3 ],
  * //   [ { _id: 'Option', _tag: 'Some', value: 3 }, 4 ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3693,6 +3855,7 @@ const zipWithPrevious = exports.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))
@@ -3720,6 +3883,7 @@ const zipWithPrevious = exports.zipWithPrevious = internal.zipWithPrevious;
  * //     { _id: 'Option', _tag: 'None' }
  * //   ]
  * // ]
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3729,6 +3893,7 @@ const zipWithPreviousAndNext = exports.zipWithPreviousAndNext = internal.zipWith
  * Zips this stream together with the index of elements.
  *
  * @example
+ * ```ts
  * import { Effect, Stream } from "effect"
  *
  * const stream = Stream.make("Mary", "James", "Robert", "Patricia")
@@ -3740,6 +3905,7 @@ const zipWithPreviousAndNext = exports.zipWithPreviousAndNext = internal.zipWith
  * //   _id: 'Chunk',
  * //   values: [ [ 'Mary', 0 ], [ 'James', 1 ], [ 'Robert', 2 ], [ 'Patricia', 3 ] ]
  * // }
+ * ```
  *
  * @since 2.0.0
  * @category zipping
@@ -3764,6 +3930,7 @@ const zipWithIndex = exports.zipWithIndex = internal.zipWithIndex;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3773,6 +3940,7 @@ const zipWithIndex = exports.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
@@ -3794,6 +3962,7 @@ const Do = exports.Do = internal.Do;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3803,6 +3972,7 @@ const Do = exports.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
@@ -3836,6 +4006,7 @@ const bindEffect = exports.bindEffect = _groupBy.bindEffect;
  * @see {@link let_ let}
  *
  * @example
+ * ```ts
  * import { Chunk, Effect, pipe, Stream } from "effect"
  *
  * const result = pipe(
@@ -3845,6 +4016,7 @@ const bindEffect = exports.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