Fix Stream.scoped example (#4176)

Effect-TS · Dec 20, 2024 · 39457d4 · 39457d4
1 parent 0c91dd6
commit 39457d4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/.changeset/mean-rules-raise.md b/.changeset/mean-rules-raise.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+Fix Stream.scoped example
diff --git a/packages/effect/src/Stream.ts b/packages/effect/src/Stream.ts
@@ -4582,11 +4582,12 @@ export const scheduleWith: {
  *
  * // Creating a single-valued stream from a scoped resource
  * const stream = Stream.scoped(
- *   Effect.acquireUseRelease(
- *     Console.log("acquire"),
- *     () => Console.log("use"),
- *     () => Console.log("release")
- *   )
+ *  Effect.acquireRelease(
+ *    Console.log("acquire"),
+ *    () => Console.log("release")
+ *  )
+ * ).pipe(
+ *  Stream.flatMap(() => Console.log("use"))
  * )
  *
  * // Effect.runPromise(Stream.runCollect(stream)).then(console.log)