effect 4.0.0-beta.102 → 4.0.0-beta.103

package/dist/TxDeferred.d.ts

@@ -28,7 +28,7 @@ declare const TypeId = "~effect/transactions/TxDeferred";
  *
  * **Example** (Completing a transactional deferred)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
@@ -36,16 +36,16 @@ declare const TypeId = "~effect/transactions/TxDeferred";
  *
  *   // Complete the deferred
  *   const first = yield* TxDeferred.succeed(deferred, 42)
- *   console.log(first) // true
  *
  *   // Second write is a no-op
  *   const second = yield* TxDeferred.succeed(deferred, 99)
- *   console.log(second) // false
  *
  *   // Read the value
  *   const value = yield* TxDeferred.await(deferred)
- *   console.log(value) // 42
+ *   return [first, second, value]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false, 42]
  * ```
  *
  * @category models
@@ -64,14 +64,15 @@ export interface TxDeferred<in out A, in out E = never> extends Inspectable, Pip
  *
  * **Example** (Creating a transactional deferred)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Option, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<string, Error>()
- *   const state = yield* TxDeferred.poll(deferred)
- *   console.log(Option.isNone(state)) // true
+ *   return yield* TxDeferred.poll(deferred)
  * })
+ *
+ * await Effect.runPromise(program) // => Option.none()
  * ```
  *
  * @category constructors
@@ -84,15 +85,16 @@ export declare const make: <A, E = never>() => Effect.Effect<TxDeferred<A, E>>;
  *
  * **Example** (Awaiting a deferred value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   yield* TxDeferred.succeed(deferred, 42)
- *   const value = yield* TxDeferred.await(deferred)
- *   console.log(value) // 42
+ *   return yield* TxDeferred.await(deferred)
  * })
+ *
+ * await Effect.runPromise(program) // => 42
  * ```
  *
  * @category getters
@@ -125,18 +127,19 @@ await_ as await };
  *
  * **Example** (Polling a deferred)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Option, Result, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   const before = yield* TxDeferred.poll(deferred)
- *   console.log(Option.isNone(before)) // true
  *
  *   yield* TxDeferred.succeed(deferred, 42)
  *   const after = yield* TxDeferred.poll(deferred)
- *   console.log(after) // Some(Success(42))
+ *   return [before, after]
  * })
+ *
+ * await Effect.runPromise(program) // => [Option.none(), Option.some(Result.succeed(42))]
  * ```
  *
  * @category getters
@@ -153,16 +156,17 @@ export declare const poll: <A, E>(self: TxDeferred<A, E>) => Effect.Effect<Optio
  *
  * **Example** (Completing with a result)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Result, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number, string>()
  *   const first = yield* TxDeferred.done(deferred, Result.succeed(42))
- *   console.log(first) // true
  *   const second = yield* TxDeferred.done(deferred, Result.succeed(99))
- *   console.log(second) // false
+ *   return [first, second]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category mutations
@@ -179,16 +183,17 @@ export declare const done: {
      *
      * **Example** (Completing with a result)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { Effect, Result, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number, string>()
      *   const first = yield* TxDeferred.done(deferred, Result.succeed(42))
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.done(deferred, Result.succeed(99))
-     *   console.log(second) // false
+     *   return [first, second]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false]
      * ```
      *
      * @category mutations
@@ -205,16 +210,17 @@ export declare const done: {
      *
      * **Example** (Completing with a result)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { Effect, Result, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number, string>()
      *   const first = yield* TxDeferred.done(deferred, Result.succeed(42))
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.done(deferred, Result.succeed(99))
-     *   console.log(second) // false
+     *   return [first, second]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false]
      * ```
      *
      * @category mutations
@@ -232,16 +238,17 @@ export declare const done: {
  *
  * **Example** (Completing with a success value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   const first = yield* TxDeferred.succeed(deferred, 42)
- *   console.log(first) // true
  *   const second = yield* TxDeferred.succeed(deferred, 99)
- *   console.log(second) // false
+ *   return [first, second]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category mutations
@@ -258,16 +265,17 @@ export declare const succeed: {
      *
      * **Example** (Completing with a success value)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { Effect, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number>()
      *   const first = yield* TxDeferred.succeed(deferred, 42)
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.succeed(deferred, 99)
-     *   console.log(second) // false
+     *   return [first, second]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false]
      * ```
      *
      * @category mutations
@@ -284,16 +292,17 @@ export declare const succeed: {
      *
      * **Example** (Completing with a success value)
      *
-     * ```ts
+     * ```ts import.meta.vitest
      * import { Effect, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number>()
      *   const first = yield* TxDeferred.succeed(deferred, 42)
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.succeed(deferred, 99)
-     *   console.log(second) // false
+     *   return [first, second]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false]
      * ```
      *
      * @category mutations
@@ -311,16 +320,18 @@ export declare const succeed: {
  *
  * **Example** (Completing with a failure)
  *
- * ```ts
- * import { Effect, TxDeferred } from "effect"
+ * ```ts import.meta.vitest
+ * import { Cause, Effect, Exit, Option, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number, string>()
  *   const first = yield* TxDeferred.fail(deferred, "boom")
- *   console.log(first) // true
  *   const second = yield* TxDeferred.fail(deferred, "boom2")
- *   console.log(second) // false
+ *   const exit = yield* Effect.exit(TxDeferred.await(deferred))
+ *   return [first, second, exit, Exit.getCause(exit)]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false, Exit.fail("boom"), Option.some(Cause.fail("boom"))]
  * ```
  *
  * @category mutations
@@ -337,16 +348,18 @@ export declare const fail: {
      *
      * **Example** (Completing with a failure)
      *
-     * ```ts
-     * import { Effect, TxDeferred } from "effect"
+     * ```ts import.meta.vitest
+     * import { Cause, Effect, Exit, Option, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number, string>()
      *   const first = yield* TxDeferred.fail(deferred, "boom")
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.fail(deferred, "boom2")
-     *   console.log(second) // false
+     *   const exit = yield* Effect.exit(TxDeferred.await(deferred))
+     *   return [first, second, exit, Exit.getCause(exit)]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false, Exit.fail("boom"), Option.some(Cause.fail("boom"))]
      * ```
      *
      * @category mutations
@@ -363,16 +376,18 @@ export declare const fail: {
      *
      * **Example** (Completing with a failure)
      *
-     * ```ts
-     * import { Effect, TxDeferred } from "effect"
+     * ```ts import.meta.vitest
+     * import { Cause, Effect, Exit, Option, TxDeferred } from "effect"
      *
      * const program = Effect.gen(function*() {
      *   const deferred = yield* TxDeferred.make<number, string>()
      *   const first = yield* TxDeferred.fail(deferred, "boom")
-     *   console.log(first) // true
      *   const second = yield* TxDeferred.fail(deferred, "boom2")
-     *   console.log(second) // false
+     *   const exit = yield* Effect.exit(TxDeferred.await(deferred))
+     *   return [first, second, exit, Exit.getCause(exit)]
      * })
+     *
+     * await Effect.runPromise(program) // => [true, false, Exit.fail("boom"), Option.some(Cause.fail("boom"))]
      * ```
      *
      * @category mutations
@@ -389,14 +404,15 @@ export declare const fail: {
  *
  * **Example** (Checking transactional deferreds)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
- *   console.log(TxDeferred.isTxDeferred(deferred)) // true
- *   console.log(TxDeferred.isTxDeferred("not a deferred")) // false
+ *   return [TxDeferred.isTxDeferred(deferred), TxDeferred.isTxDeferred("not a deferred")]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category guards

package/dist/TxDeferred.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxDeferred.d.ts","sourceRoot":"","sources":["../src/TxDeferred.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACnF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;CAChD;AAuBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,GAAG,KAAK,OAAK,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CACI,CAAA;AAExE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,QAAA,MAAM,MAAM,GAAI,CAAC,EAAE,CAAC,QAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAS7C,CAAA;AAEpB,OAAO;AACL;;;;;;;;;;;;;GAaG;AACH,MAAM,IAAI,KAAK,EAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,QAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAwB,CAAA;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAChF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAU7E,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACpE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAIjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACpE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAIjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,MAAO,OAAO,KAAG,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAA2B,CAAA"}
+{"version":3,"file":"TxDeferred.d.ts","sourceRoot":"","sources":["../src/TxDeferred.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACnF,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;CAChD;AAuBD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,GAAG,KAAK,OAAK,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CACI,CAAA;AAExE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,MAAM,GAAI,CAAC,EAAE,CAAC,QAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAS7C,CAAA;AAEpB,OAAO;AACL;;;;;;;;;;;;;GAaG;AACH,MAAM,IAAI,KAAK,EAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,QAAQ,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAwB,CAAA;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAChF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAU7E,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACpE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAIjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,IAAI,EAAE;IACjB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACpE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;CAIjE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,MAAO,OAAO,KAAG,CAAC,IAAI,UAAU,CAAC,OAAO,EAAE,OAAO,CAA2B,CAAA"}

package/dist/TxDeferred.js

@@ -46,14 +46,15 @@ const makeTxDeferred = ref => {
  *
  * **Example** (Creating a transactional deferred)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Option, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<string, Error>()
- *   const state = yield* TxDeferred.poll(deferred)
- *   console.log(Option.isNone(state)) // true
+ *   return yield* TxDeferred.poll(deferred)
  * })
+ *
+ * await Effect.runPromise(program) // => Option.none()
  * ```
  *
  * @category constructors
@@ -66,15 +67,16 @@ export const make = () => Effect.map(TxRef.make(O.none()), makeTxDeferred);
  *
  * **Example** (Awaiting a deferred value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   yield* TxDeferred.succeed(deferred, 42)
- *   const value = yield* TxDeferred.await(deferred)
- *   console.log(value) // 42
+ *   return yield* TxDeferred.await(deferred)
  * })
+ *
+ * await Effect.runPromise(program) // => 42
  * ```
  *
  * @category getters
@@ -113,18 +115,19 @@ await_ as await };
  *
  * **Example** (Polling a deferred)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Option, Result, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   const before = yield* TxDeferred.poll(deferred)
- *   console.log(Option.isNone(before)) // true
  *
  *   yield* TxDeferred.succeed(deferred, 42)
  *   const after = yield* TxDeferred.poll(deferred)
- *   console.log(after) // Some(Success(42))
+ *   return [before, after]
  * })
+ *
+ * await Effect.runPromise(program) // => [Option.none(), Option.some(Result.succeed(42))]
  * ```
  *
  * @category getters
@@ -141,16 +144,17 @@ export const poll = self => TxRef.get(self.ref);
  *
  * **Example** (Completing with a result)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Result, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number, string>()
  *   const first = yield* TxDeferred.done(deferred, Result.succeed(42))
- *   console.log(first) // true
  *   const second = yield* TxDeferred.done(deferred, Result.succeed(99))
- *   console.log(second) // false
+ *   return [first, second]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category mutations
@@ -172,16 +176,17 @@ export const done = /*#__PURE__*/dual(2, (self, result) => TxRef.modify(self.ref
  *
  * **Example** (Completing with a success value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
  *   const first = yield* TxDeferred.succeed(deferred, 42)
- *   console.log(first) // true
  *   const second = yield* TxDeferred.succeed(deferred, 99)
- *   console.log(second) // false
+ *   return [first, second]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category mutations
@@ -198,16 +203,18 @@ export const succeed = /*#__PURE__*/dual(2, (self, value) => done(self, Res.succ
  *
  * **Example** (Completing with a failure)
  *
- * ```ts
- * import { Effect, TxDeferred } from "effect"
+ * ```ts import.meta.vitest
+ * import { Cause, Effect, Exit, Option, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number, string>()
  *   const first = yield* TxDeferred.fail(deferred, "boom")
- *   console.log(first) // true
  *   const second = yield* TxDeferred.fail(deferred, "boom2")
- *   console.log(second) // false
+ *   const exit = yield* Effect.exit(TxDeferred.await(deferred))
+ *   return [first, second, exit, Exit.getCause(exit)]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false, Exit.fail("boom"), Option.some(Cause.fail("boom"))]
  * ```
  *
  * @category mutations
@@ -223,14 +230,15 @@ export const fail = /*#__PURE__*/dual(2, (self, error) => done(self, Res.fail(er
  *
  * **Example** (Checking transactional deferreds)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxDeferred } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const deferred = yield* TxDeferred.make<number>()
- *   console.log(TxDeferred.isTxDeferred(deferred)) // true
- *   console.log(TxDeferred.isTxDeferred("not a deferred")) // false
+ *   return [TxDeferred.isTxDeferred(deferred), TxDeferred.isTxDeferred("not a deferred")]
  * })
+ *
+ * await Effect.runPromise(program) // => [true, false]
  * ```
  *
  * @category guards

package/dist/TxDeferred.js.map

@@ -1 +1 @@
-{"version":3,"file":"TxDeferred.js","names":["Effect","dual","NodeInspectSymbol","toJson","O","pipeArguments","hasProperty","Res","TxRef","TypeId","TxDeferredProto","toJSON","_id","pipe","arguments","makeTxDeferred","ref","self","Object","create","make","map","none","await_","gen","option","get","isNone","txRetry","isSuccess","value","success","fail","failure","tx","await","poll","done","result","modify","current","isSome","some","succeed","error","isTxDeferred","u"],"sources":["../src/TxDeferred.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;AAYA,OAAO,KAAKA,MAAM,MAAM,aAAa;AACrC,SAASC,IAAI,QAAQ,eAAe;AAEpC,SAASC,iBAAiB,EAAEC,MAAM,QAAQ,kBAAkB;AAE5D,OAAO,KAAKC,CAAC,MAAM,aAAa;AAEhC,SAASC,aAAa,QAAQ,eAAe;AAC7C,SAASC,WAAW,QAAQ,gBAAgB;AAE5C,OAAO,KAAKC,GAAG,MAAM,aAAa;AAClC,OAAO,KAAKC,KAAK,MAAM,YAAY;AAEnC,MAAMC,MAAM,GAAG,iCAAiC;AA0ChD,MAAMC,eAAe,GAA8D;EACjF,CAACR,iBAAiB,IAAC;IACjB,OAAOC,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACDQ,MAAMA,CAAA;IACJ,OAAO;MACLC,GAAG,EAAE;KACN;EACH,CAAC;EACDC,IAAIA,CAAA;IACF,OAAOR,aAAa,CAAC,IAAI,EAAES,SAAS,CAAC;EACvC;CACD;AAED,MAAMC,cAAc,GAAUC,GAAsC,IAAsB;EACxF,MAAMC,IAAI,GAAGC,MAAM,CAACC,MAAM,CAACT,eAAe,CAAC;EAC3CO,IAAI,CAACR,MAAM,CAAC,GAAGA,MAAM;EACrBQ,IAAI,CAACD,GAAG,GAAGA,GAAG;EACd,OAAOC,IAAI;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMG,IAAI,GAAGA,CAAA,KAClBpB,MAAM,CAACqB,GAAG,CAACb,KAAK,CAACY,IAAI,CAAuBhB,CAAC,CAACkB,IAAI,EAAE,CAAC,EAAEP,cAAc,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;AAoBA,MAAMQ,MAAM,GAAUN,IAAsB,IAC1CjB,MAAM,CAACwB,GAAG,CAAC,aAAS;EAClB,MAAMC,MAAM,GAAG,OAAOjB,KAAK,CAACkB,GAAG,CAACT,IAAI,CAACD,GAAG,CAAC;EACzC,IAAIZ,CAAC,CAACuB,MAAM,CAACF,MAAM,CAAC,EAAE;IACpB,OAAO,OAAOzB,MAAM,CAAC4B,OAAO;EAC9B;EACA,OAAOrB,GAAG,CAACsB,SAAS,CAACJ,MAAM,CAACK,KAAK,CAAC,GAC9BL,MAAM,CAACK,KAAK,CAACC,OAAO,GACpB,OAAO/B,MAAM,CAACgC,IAAI,CAACP,MAAM,CAACK,KAAK,CAACG,OAAO,CAAC;AAC9C,CAAC,CAAC,CAACpB,IAAI,CAACb,MAAM,CAACkC,EAAE,CAAC;AAEpB;AACE;;;;;;;;;;;;;;AAcAX,MAAM,IAAIY,KAAK;AAGjB;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMC,IAAI,GAAUnB,IAAsB,IAA0CT,KAAK,CAACkB,GAAG,CAACT,IAAI,CAACD,GAAG,CAAC;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMqB,IAAI,gBAqDbpC,IAAI,CACN,CAAC,EACD,CAAOgB,IAAsB,EAAEqB,MAAoB,KACjD9B,KAAK,CAAC+B,MAAM,CAACtB,IAAI,CAACD,GAAG,EAAGwB,OAAO,IAAI;EACjC,IAAIpC,CAAC,CAACqC,MAAM,CAACD,OAAO,CAAC,EAAE;IACrB,OAAO,CAAC,KAAK,EAAEA,OAAO,CAAC;EACzB;EACA,OAAO,CAAC,IAAI,EAAEpC,CAAC,CAACsC,IAAI,CAACJ,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC,CACL;AAED;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMK,OAAO,gBAqDhB1C,IAAI,CACN,CAAC,EACD,CAAOgB,IAAsB,EAAEa,KAAQ,KAA6BO,IAAI,CAACpB,IAAI,EAAEV,GAAG,CAACoC,OAAO,CAACb,KAAK,CAAC,CAAC,CACnG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAME,IAAI,gBAqDb/B,IAAI,CACN,CAAC,EACD,CAAOgB,IAAsB,EAAE2B,KAAQ,KAA6BP,IAAI,CAACpB,IAAI,EAAEV,GAAG,CAACyB,IAAI,CAACY,KAAK,CAAC,CAAC,CAChG;AAED;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,MAAMC,YAAY,GAAIC,CAAU,IAAwCxC,WAAW,CAACwC,CAAC,EAAErC,MAAM,CAAC","ignoreList":[]}
+{"version":3,"file":"TxDeferred.js","names":[],"sources":["../src/TxDeferred.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;AAYA,OAAO,KAAK,MAAM,MAAM,aAAa;AACrC,SAAS,IAAI,QAAQ,eAAe;AAEpC,SAAS,iBAAiB,EAAE,MAAM,QAAQ,kBAAkB;AAE5D,OAAO,KAAK,CAAC,MAAM,aAAa;AAEhC,SAAS,aAAa,QAAQ,eAAe;AAC7C,SAAS,WAAW,QAAQ,gBAAgB;AAE5C,OAAO,KAAK,GAAG,MAAM,aAAa;AAClC,OAAO,KAAK,KAAK,MAAM,YAAY;AAEnC,MAAM,MAAM,GAAG,iCAAiC;AA0ChD,MAAM,eAAe,GAA8D;EACjF,CAAC,iBAAiB,IAAC;IACjB,OAAO,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACD,MAAM;IACJ,OAAO;MACL,GAAG,EAAE;KACN;EACH,CAAC;EACD,IAAI;IACF,OAAO,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC;EACvC;CACD;AAED,MAAM,cAAc,GAAU,GAAsC,IAAsB;EACxF,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC;EAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,MAAM;EACrB,IAAI,CAAC,GAAG,GAAG,GAAG;EACd,OAAO,IAAI;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAM,IAAI,GAAG,MAClB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAuB,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,cAAc,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;AAqBA,MAAM,MAAM,GAAU,IAAsB,IAC1C,MAAM,CAAC,GAAG,CAAC,aAAS;EAClB,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;EACzC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;IACpB,OAAO,OAAO,MAAM,CAAC,OAAO;EAC9B;EACA,OAAO,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,GAC9B,MAAM,CAAC,KAAK,CAAC,OAAO,GACpB,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;AAC9C,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;AAEpB;AACE;;;;;;;;;;;;;;AAcA,MAAM,IAAI,KAAK;AAGjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,MAAM,IAAI,GAAU,IAAsB,IAA0C,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;AAE9G;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAM,IAAI,gBAuDb,IAAI,CACN,CAAC,EACD,CAAO,IAAsB,EAAE,MAAoB,KACjD,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAG,OAAO,IAAI;EACjC,IAAI,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;IACrB,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;EACzB;EACA,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC,CACL;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,OAAO,MAAM,OAAO,gBAuDhB,IAAI,CACN,CAAC,EACD,CAAO,IAAsB,EAAE,KAAQ,KAA6B,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CACnG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAM,IAAI,gBAyDb,IAAI,CACN,CAAC,EACD,CAAO,IAAsB,EAAE,KAAQ,KAA6B,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAChG;AAED;;;;;;;;;;;;;;;;;;;;;;;AAuBA,OAAO,MAAM,YAAY,GAAI,CAAU,IAAwC,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC","ignoreList":[]}