Add documentation to Effect.intoDeferred (#2004)

Effect-TS · Jan 29, 2024 · 22794e0 · 22794e0
1 parent 6bf02c7
commit 22794e0
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.changeset/brown-experts-design.md b/.changeset/brown-experts-design.md
@@ -0,0 +1,5 @@
+---
+"effect": patch
+---
+
+add documentation to Effect.intoDeferred
diff --git a/packages/effect/src/Effect.ts b/packages/effect/src/Effect.ts
@@ -3306,6 +3306,11 @@ export const either: <R, E, A>(self: Effect<R, E, A>) => Effect<R, never, Either
 export const exit: <R, E, A>(self: Effect<R, E, A>) => Effect<R, never, Exit.Exit<E, A>> = core.exit
 
 /**
+ * Returns an effect that will succeed or fail the specified `Deferred` based
+ * upon the result of the effect. Also synchronizes interruption, so if the
+ * provided effect is interrupted, the specified `Deferred` will be interrupted
+ * as well.
+ *
  * @since 2.0.0
  * @category conversions
  */