effect 4.0.0-beta.102 → 4.0.0-beta.104

package/src/TxSubscriptionRef.ts

@@ -36,24 +36,25 @@ const TypeId = "~effect/transactions/TxSubscriptionRef"
  *
  * **Example** (Subscribing to transactional changes)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxQueue, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(0)
  *
- *   yield* Effect.scoped(
+ *   return yield* Effect.scoped(
  *     Effect.gen(function*() {
  *       const sub = yield* TxSubscriptionRef.changes(ref)
  *       const initial = yield* TxQueue.take(sub)
- *       console.log(initial) // 0
  *
  *       yield* TxSubscriptionRef.set(ref, 1)
  *       const next = yield* TxQueue.take(sub)
- *       console.log(next) // 1
+ *       return [initial, next]
  *     })
  *   )
  * })
+ *
+ * await Effect.runPromise(program) // => [0, 1]
  * ```
  *
  * @see {@link make} for creating a transactional subscription reference
@@ -100,14 +101,15 @@ const TxSubscriptionRefProto: Omit<TxSubscriptionRef<any>, typeof TypeId | "ref"
  *
  * **Example** (Creating a transactional subscription reference)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(42)
- *   const value = yield* TxSubscriptionRef.get(ref)
- *   console.log(value) // 42
+ *   return yield* TxSubscriptionRef.get(ref)
  * })
+ *
+ * await Effect.runPromise(program) // => 42
  * ```
  *
  * @see {@link changes} for subscribing to the created reference
@@ -140,14 +142,15 @@ export const make = <A>(value: A): Effect.Effect<TxSubscriptionRef<A>> =>
  *
  * **Example** (Reading the current value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make("hello")
- *   const value = yield* TxSubscriptionRef.get(ref)
- *   console.log(value) // "hello"
+ *   return yield* TxSubscriptionRef.get(ref)
  * })
+ *
+ * await Effect.runPromise(program) // => "hello"
  * ```
  *
  * @see {@link changes} for reading the current value and subsequent updates
@@ -172,15 +175,16 @@ export const get = <A>(self: TxSubscriptionRef<A>): Effect.Effect<A> => TxRef.ge
  *
  * **Example** (Modifying and returning a value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(10)
  *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
- *   console.log(result) // "was 10"
- *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+ *   return [result, yield* TxSubscriptionRef.get(ref)]
  * })
+ *
+ * await Effect.runPromise(program) // => ["was 10", 11]
  * ```
  *
  * @see {@link update} for deriving the next value without a separate return value
@@ -205,15 +209,16 @@ export const modify: {
    *
    * **Example** (Modifying and returning a value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(10)
    *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
-   *   console.log(result) // "was 10"
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   *   return [result, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => ["was 10", 11]
    * ```
    *
    * @see {@link update} for deriving the next value without a separate return value
@@ -238,15 +243,16 @@ export const modify: {
    *
    * **Example** (Modifying and returning a value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(10)
    *   const result = yield* TxSubscriptionRef.modify(ref, (n) => [`was ${n}`, n + 1])
-   *   console.log(result) // "was 10"
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   *   return [result, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => ["was 10", 11]
    * ```
    *
    * @see {@link update} for deriving the next value without a separate return value
@@ -284,14 +290,16 @@ export const modify: {
  *
  * **Example** (Setting a new value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(0)
  *   yield* TxSubscriptionRef.set(ref, 42)
- *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+ *   return yield* TxSubscriptionRef.get(ref)
  * })
+ *
+ * await Effect.runPromise(program) // => 42
  * ```
  *
  * @see {@link update} for deriving the new value from the current value
@@ -311,14 +319,16 @@ export const set: {
    *
    * **Example** (Setting a new value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(0)
    *   yield* TxSubscriptionRef.set(ref, 42)
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+   *   return yield* TxSubscriptionRef.get(ref)
    * })
+   *
+   * await Effect.runPromise(program) // => 42
    * ```
    *
    * @see {@link update} for deriving the new value from the current value
@@ -338,14 +348,16 @@ export const set: {
    *
    * **Example** (Setting a new value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(0)
    *   yield* TxSubscriptionRef.set(ref, 42)
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 42
+   *   return yield* TxSubscriptionRef.get(ref)
    * })
+   *
+   * await Effect.runPromise(program) // => 42
    * ```
    *
    * @see {@link update} for deriving the new value from the current value
@@ -371,14 +383,16 @@ export const set: {
  *
  * **Example** (Updating a value)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(5)
  *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
- *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+ *   return yield* TxSubscriptionRef.get(ref)
  * })
+ *
+ * await Effect.runPromise(program) // => 10
  * ```
  *
  * @see {@link set} for replacing the value directly
@@ -399,14 +413,16 @@ export const update: {
    *
    * **Example** (Updating a value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(5)
    *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+   *   return yield* TxSubscriptionRef.get(ref)
    * })
+   *
+   * await Effect.runPromise(program) // => 10
    * ```
    *
    * @see {@link set} for replacing the value directly
@@ -427,14 +443,16 @@ export const update: {
    *
    * **Example** (Updating a value)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(5)
    *   yield* TxSubscriptionRef.update(ref, (n) => n * 2)
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 10
+   *   return yield* TxSubscriptionRef.get(ref)
    * })
+   *
+   * await Effect.runPromise(program) // => 10
    * ```
    *
    * @see {@link set} for replacing the value directly
@@ -461,15 +479,16 @@ export const update: {
  *
  * **Example** (Getting and setting atomically)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make("a")
  *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
- *   console.log(old) // "a"
- *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+ *   return [old, yield* TxSubscriptionRef.get(ref)]
  * })
+ *
+ * await Effect.runPromise(program) // => ["a", "b"]
  * ```
  *
  * @see {@link set} for setting without returning the previous value
@@ -490,15 +509,16 @@ export const getAndSet: {
    *
    * **Example** (Getting and setting atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make("a")
    *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
-   *   console.log(old) // "a"
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+   *   return [old, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => ["a", "b"]
    * ```
    *
    * @see {@link set} for setting without returning the previous value
@@ -519,15 +539,16 @@ export const getAndSet: {
    *
    * **Example** (Getting and setting atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make("a")
    *   const old = yield* TxSubscriptionRef.getAndSet(ref, "b")
-   *   console.log(old) // "a"
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // "b"
+   *   return [old, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => ["a", "b"]
    * ```
    *
    * @see {@link set} for setting without returning the previous value
@@ -553,15 +574,16 @@ export const getAndSet: {
  *
  * **Example** (Getting and updating atomically)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(1)
  *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
- *   console.log(old) // 1
- *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+ *   return [old, yield* TxSubscriptionRef.get(ref)]
  * })
+ *
+ * await Effect.runPromise(program) // => [1, 11]
  * ```
  *
  * @see {@link update} for updating without returning the previous value
@@ -582,15 +604,16 @@ export const getAndUpdate: {
    *
    * **Example** (Getting and updating atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(1)
    *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
-   *   console.log(old) // 1
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   *   return [old, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => [1, 11]
    * ```
    *
    * @see {@link update} for updating without returning the previous value
@@ -611,15 +634,16 @@ export const getAndUpdate: {
    *
    * **Example** (Getting and updating atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(1)
    *   const old = yield* TxSubscriptionRef.getAndUpdate(ref, (n) => n + 10)
-   *   console.log(old) // 1
-   *   console.log(yield* TxSubscriptionRef.get(ref)) // 11
+   *   return [old, yield* TxSubscriptionRef.get(ref)]
    * })
+   *
+   * await Effect.runPromise(program) // => [1, 11]
    * ```
    *
    * @see {@link update} for updating without returning the previous value
@@ -646,14 +670,15 @@ export const getAndUpdate: {
  *
  * **Example** (Updating and reading atomically)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(3)
- *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
- *   console.log(result) // 9
+ *   return yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
  * })
+ *
+ * await Effect.runPromise(program) // => 9
  * ```
  *
  * @see {@link update} for updating without returning the new value
@@ -674,14 +699,15 @@ export const updateAndGet: {
    *
    * **Example** (Updating and reading atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(3)
-   *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
-   *   console.log(result) // 9
+   *   return yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
    * })
+   *
+   * await Effect.runPromise(program) // => 9
    * ```
    *
    * @see {@link update} for updating without returning the new value
@@ -702,14 +728,15 @@ export const updateAndGet: {
    *
    * **Example** (Updating and reading atomically)
    *
-   * ```ts
+   * ```ts import.meta.vitest
    * import { Effect, TxSubscriptionRef } from "effect"
    *
    * const program = Effect.gen(function*() {
    *   const ref = yield* TxSubscriptionRef.make(3)
-   *   const result = yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
-   *   console.log(result) // 9
+   *   return yield* TxSubscriptionRef.updateAndGet(ref, (n) => n * 3)
    * })
+   *
+   * await Effect.runPromise(program) // => 9
    * ```
    *
    * @see {@link update} for updating without returning the new value
@@ -743,24 +770,25 @@ export const updateAndGet: {
  *
  * **Example** (Subscribing to changes)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, TxQueue, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
  *   const ref = yield* TxSubscriptionRef.make(0)
  *
- *   yield* Effect.scoped(
+ *   return yield* Effect.scoped(
  *     Effect.gen(function*() {
  *       const sub = yield* TxSubscriptionRef.changes(ref)
  *       const initial = yield* TxQueue.take(sub)
- *       console.log(initial) // 0
  *
  *       yield* TxSubscriptionRef.set(ref, 1)
  *       const next = yield* TxQueue.take(sub)
- *       console.log(next) // 1
+ *       return [initial, next]
  *     })
  *   )
  * })
+ *
+ * await Effect.runPromise(program) // => [0, 1]
  * ```
  *
  * @see {@link changesStream} for subscribing through a `Stream`
@@ -793,7 +821,7 @@ export const changes = <A>(
  *
  * **Example** (Streaming changes)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { Effect, Stream, TxSubscriptionRef } from "effect"
  *
  * const program = Effect.gen(function*() {
@@ -804,8 +832,10 @@ export const changes = <A>(
  *   const values = yield* Stream.runCollect(
  *     TxSubscriptionRef.changesStream(ref).pipe(Stream.take(1))
  *   )
- *   console.log(values) // [2]
+ *   return Array.from(values)
  * })
+ *
+ * await Effect.runPromise(program) // => [2]
  * ```
  *
  * @see {@link changes} for subscribing through a transactional queue
@@ -834,14 +864,11 @@ export const changesStream = <A>(self: TxSubscriptionRef<A>): Stream.Stream<A, n
  *
  * **Example** (Checking transactional subscription references)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { TxSubscriptionRef } from "effect"
  *
- * declare const someValue: unknown
- *
- * if (TxSubscriptionRef.isTxSubscriptionRef(someValue)) {
- *   console.log("This is a TxSubscriptionRef")
- * }
+ * const someValue: unknown = {}
+ * TxSubscriptionRef.isTxSubscriptionRef(someValue) // => false
  * ```
  *
  * @see {@link make} for creating a `TxSubscriptionRef`