effect 4.0.0-beta.65 → 4.0.0-beta.67

package/dist/TxSubscriptionRef.d.ts

@@ -16,7 +16,8 @@ declare const TypeId = "~effect/transactions/TxSubscriptionRef";
  * committed changes. Subscribers receive the current value followed by every subsequent
  * update via a transactional dequeue.
  *
- * @example
+ * **Example** (Subscribing to transactional changes)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
  *
@@ -37,8 +38,8 @@ declare const TypeId = "~effect/transactions/TxSubscriptionRef";
  * })
  * ```
  *
- * @since 4.0.0
  * @category models
+ * @since 4.0.0
  */
 export interface TxSubscriptionRef<in out A> extends Inspectable, Pipeable {
     readonly [TypeId]: typeof TypeId;
@@ -46,7 +47,8 @@ export interface TxSubscriptionRef<in out A> extends Inspectable, Pipeable {
 /**
  * Creates a new TxSubscriptionRef with the specified initial value.
  *
- * @example
+ * **Example** (Creating a transactional subscription reference)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -57,14 +59,15 @@ export interface TxSubscriptionRef<in out A> extends Inspectable, Pipeable {
  * })
  * ```
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export declare const make: <A>(value: A) => Effect.Effect<TxSubscriptionRef<A>>;
 /**
  * Reads the current value of the TxSubscriptionRef.
  *
- * @example
+ * **Example** (Reading the current value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -75,15 +78,16 @@ export declare const make: <A>(value: A) => Effect.Effect<TxSubscriptionRef<A>>;
  * })
  * ```
  *
- * @since 4.0.0
  * @category getters
+ * @since 4.0.0
  */
 export declare const get: <A>(self: TxSubscriptionRef<A>) => Effect.Effect<A>;
 /**
  * Modifies the value of the TxSubscriptionRef using a function that returns both a
  * result and the new value. The new value is published to all subscribers atomically.
  *
- * @example
+ * **Example** (Modifying and returning a value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -95,15 +99,16 @@ export declare const get: <A>(self: TxSubscriptionRef<A>) => Effect.Effect<A>;
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const modify: {
     /**
      * Modifies the value of the TxSubscriptionRef using a function that returns both a
      * result and the new value. The new value is published to all subscribers atomically.
      *
-     * @example
+     * **Example** (Modifying and returning a value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -115,15 +120,16 @@ export declare const modify: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A, B>(f: (current: A) => [returnValue: B, newValue: A]): (self: TxSubscriptionRef<A>) => Effect.Effect<B>;
     /**
      * Modifies the value of the TxSubscriptionRef using a function that returns both a
      * result and the new value. The new value is published to all subscribers atomically.
      *
-     * @example
+     * **Example** (Modifying and returning a value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -135,15 +141,16 @@ export declare const modify: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A, B>(self: TxSubscriptionRef<A>, f: (current: A) => [returnValue: B, newValue: A]): Effect.Effect<B>;
 };
 /**
  * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
  *
- * @example
+ * **Example** (Setting a new value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -154,14 +161,15 @@ export declare const modify: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const set: {
     /**
      * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
      *
-     * @example
+     * **Example** (Setting a new value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -172,14 +180,15 @@ export declare const set: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<void>;
     /**
      * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
      *
-     * @example
+     * **Example** (Setting a new value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -190,8 +199,8 @@ export declare const set: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<void>;
 };
@@ -199,7 +208,8 @@ export declare const set: {
  * Updates the value of the TxSubscriptionRef using a function and publishes the new
  * value to all subscribers.
  *
- * @example
+ * **Example** (Updating a value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -210,15 +220,16 @@ export declare const set: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const update: {
     /**
      * Updates the value of the TxSubscriptionRef using a function and publishes the new
      * value to all subscribers.
      *
-     * @example
+     * **Example** (Updating a value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -229,15 +240,16 @@ export declare const update: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<void>;
     /**
      * Updates the value of the TxSubscriptionRef using a function and publishes the new
      * value to all subscribers.
      *
-     * @example
+     * **Example** (Updating a value)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -248,8 +260,8 @@ export declare const update: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<void>;
 };
@@ -257,7 +269,8 @@ export declare const update: {
  * Gets the current value and sets a new value atomically. Publishes the new value
  * to all subscribers.
  *
- * @example
+ * **Example** (Getting and setting atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -269,15 +282,16 @@ export declare const update: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const getAndSet: {
     /**
      * Gets the current value and sets a new value atomically. Publishes the new value
      * to all subscribers.
      *
-     * @example
+     * **Example** (Getting and setting atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -289,15 +303,16 @@ export declare const getAndSet: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(value: A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>;
     /**
      * Gets the current value and sets a new value atomically. Publishes the new value
      * to all subscribers.
      *
-     * @example
+     * **Example** (Getting and setting atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -309,8 +324,8 @@ export declare const getAndSet: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(self: TxSubscriptionRef<A>, value: A): Effect.Effect<A>;
 };
@@ -318,7 +333,8 @@ export declare const getAndSet: {
  * Gets the current value and updates it using a function atomically. Publishes
  * the new value to all subscribers.
  *
- * @example
+ * **Example** (Getting and updating atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -330,15 +346,16 @@ export declare const getAndSet: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const getAndUpdate: {
     /**
      * Gets the current value and updates it using a function atomically. Publishes
      * the new value to all subscribers.
      *
-     * @example
+     * **Example** (Getting and updating atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -350,15 +367,16 @@ export declare const getAndUpdate: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>;
     /**
      * Gets the current value and updates it using a function atomically. Publishes
      * the new value to all subscribers.
      *
-     * @example
+     * **Example** (Getting and updating atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -370,8 +388,8 @@ export declare const getAndUpdate: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A>;
 };
@@ -379,7 +397,8 @@ export declare const getAndUpdate: {
  * Updates the value using a function and returns the new value. Publishes the
  * new value to all subscribers.
  *
- * @example
+ * **Example** (Updating and reading atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -390,15 +409,16 @@ export declare const getAndUpdate: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export declare const updateAndGet: {
     /**
      * Updates the value using a function and returns the new value. Publishes the
      * new value to all subscribers.
      *
-     * @example
+     * **Example** (Updating and reading atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -409,15 +429,16 @@ export declare const updateAndGet: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(f: (current: A) => A): (self: TxSubscriptionRef<A>) => Effect.Effect<A>;
     /**
      * Updates the value using a function and returns the new value. Publishes the
      * new value to all subscribers.
      *
-     * @example
+     * **Example** (Updating and reading atomically)
+     *
      * ```ts
      * import { Effect, TxSubscriptionRef } from "effect"
      *
@@ -428,8 +449,8 @@ export declare const updateAndGet: {
      * })
      * ```
      *
-     * @since 4.0.0
      * @category mutations
+     * @since 4.0.0
      */
     <A>(self: TxSubscriptionRef<A>, f: (current: A) => A): Effect.Effect<A>;
 };
@@ -437,7 +458,8 @@ export declare const updateAndGet: {
  * Subscribes to all changes of the TxSubscriptionRef. Returns a scoped TxDequeue
  * that first yields the current value, then every subsequent update.
  *
- * @example
+ * **Example** (Subscribing to changes)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
  *
@@ -458,15 +480,16 @@ export declare const updateAndGet: {
  * })
  * ```
  *
- * @since 4.0.0
  * @category subscriptions
+ * @since 4.0.0
  */
 export declare const changes: <A>(self: TxSubscriptionRef<A>) => Effect.Effect<TxQueue.TxQueue<A>, never, Scope.Scope>;
 /**
  * Returns a Stream of all changes to the TxSubscriptionRef, starting with the
  * current value followed by every subsequent update.
  *
- * @example
+ * **Example** (Streaming changes)
+ *
  * ```ts
  * import { Effect, Stream, TxSubscriptionRef } from "effect"
  *
@@ -482,14 +505,15 @@ export declare const changes: <A>(self: TxSubscriptionRef<A>) => Effect.Effect<T
  * })
  * ```
  *
- * @since 4.0.0
  * @category subscriptions
+ * @since 4.0.0
  */
 export declare const changesStream: <A>(self: TxSubscriptionRef<A>) => Stream.Stream<A, never, never>;
 /**
  * Checks if the given value is a TxSubscriptionRef.
  *
- * @example
+ * **Example** (Checking transactional subscription references)
+ *
  * ```ts
  * import { TxSubscriptionRef } from "effect"
  *
@@ -500,8 +524,8 @@ export declare const changesStream: <A>(self: TxSubscriptionRef<A>) => Stream.St
  * }
  * ```
  *
- * @since 4.0.0
  * @category guards
+ * @since 4.0.0
  */
 export declare const isTxSubscriptionRef: (u: unknown) => u is TxSubscriptionRef<unknown>;
 export {};

package/dist/TxSubscriptionRef.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TxSubscriptionRef.d.ts","sourceRoot":"","sources":["../src/TxSubscriptionRef.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,QAAA,MAAM,MAAM,2CAA2C,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,iBAAiB,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACxE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;CAKjC;AAqBD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CASjD,CAAA;AAMpB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAwB,CAAA;AAM3F;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,MAAM,EAAE;IAKnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAK1G;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC1B,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAcpB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAClE;;;;;;;;;;;;;;;;OAgBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAI/D,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9E;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK3E,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC/D;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAI5D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAQxE,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EACvB,MAAM,iBAAiB,CAAC,CAAC,CAAC,KACzB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAWpD,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAMxF,CAAA;AAMH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAA2B,CAAA"}
+{"version":3,"file":"TxSubscriptionRef.d.ts","sourceRoot":"","sources":["../src/TxSubscriptionRef.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAG7C,OAAO,KAAK,KAAK,KAAK,MAAM,YAAY,CAAA;AACxC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAGvC,QAAA,MAAM,MAAM,2CAA2C,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,iBAAiB,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,WAAW,EAAE,QAAQ;IACxE,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;CAKjC;AAqBD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CASjD,CAAA;AAMpB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,GAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAwB,CAAA;AAM3F;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,MAAM,EAAE;IAKnB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAK1G;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,CAAC,EACH,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAC1B,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,GAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAcpB,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,GAAG,EAAE;IAChB;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAClE;;;;;;;;;;;;;;;;;OAiBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAI/D,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC9E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;CAK3E,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC/D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAI5D,CAAA;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAKxE,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC3E;;;;;;;;;;;;;;;;;;OAkBG;IACH,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAQxE,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,EACvB,MAAM,iBAAiB,CAAC,CAAC,CAAC,KACzB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAWpD,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,MAAM,iBAAiB,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAMxF,CAAA;AAMH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,GAAI,GAAG,OAAO,KAAG,CAAC,IAAI,iBAAiB,CAAC,OAAO,CAA2B,CAAA"}

package/dist/TxSubscriptionRef.js

@@ -36,7 +36,8 @@ const TxSubscriptionRefProto = {
 /**
  * Creates a new TxSubscriptionRef with the specified initial value.
  *
- * @example
+ * **Example** (Creating a transactional subscription reference)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -47,8 +48,8 @@ const TxSubscriptionRefProto = {
  * })
  * ```
  *
- * @since 4.0.0
  * @category constructors
+ * @since 4.0.0
  */
 export const make = value => Effect.gen(function* () {
   const ref = yield* TxRef.make(value);
@@ -65,7 +66,8 @@ export const make = value => Effect.gen(function* () {
 /**
  * Reads the current value of the TxSubscriptionRef.
  *
- * @example
+ * **Example** (Reading the current value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -76,8 +78,8 @@ export const make = value => Effect.gen(function* () {
  * })
  * ```
  *
- * @since 4.0.0
  * @category getters
+ * @since 4.0.0
  */
 export const get = self => TxRef.get(self.ref);
 // =============================================================================
@@ -87,7 +89,8 @@ export const get = self => TxRef.get(self.ref);
  * Modifies the value of the TxSubscriptionRef using a function that returns both a
  * result and the new value. The new value is published to all subscribers atomically.
  *
- * @example
+ * **Example** (Modifying and returning a value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -99,8 +102,8 @@ export const get = self => TxRef.get(self.ref);
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const modify = /*#__PURE__*/dual(2, (self, f) => Effect.gen(function* () {
   const current = yield* TxRef.get(self.ref);
@@ -112,7 +115,8 @@ export const modify = /*#__PURE__*/dual(2, (self, f) => Effect.gen(function* ()
 /**
  * Sets the value of the TxSubscriptionRef and publishes the new value to all subscribers.
  *
- * @example
+ * **Example** (Setting a new value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -123,15 +127,16 @@ export const modify = /*#__PURE__*/dual(2, (self, f) => Effect.gen(function* ()
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const set = /*#__PURE__*/dual(2, (self, value) => modify(self, () => [void 0, value]));
 /**
  * Updates the value of the TxSubscriptionRef using a function and publishes the new
  * value to all subscribers.
  *
- * @example
+ * **Example** (Updating a value)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -142,15 +147,16 @@ export const set = /*#__PURE__*/dual(2, (self, value) => modify(self, () => [voi
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const update = /*#__PURE__*/dual(2, (self, f) => modify(self, current => [void 0, f(current)]));
 /**
  * Gets the current value and sets a new value atomically. Publishes the new value
  * to all subscribers.
  *
- * @example
+ * **Example** (Getting and setting atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -162,15 +168,16 @@ export const update = /*#__PURE__*/dual(2, (self, f) => modify(self, current =>
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const getAndSet = /*#__PURE__*/dual(2, (self, value) => modify(self, current => [current, value]));
 /**
  * Gets the current value and updates it using a function atomically. Publishes
  * the new value to all subscribers.
  *
- * @example
+ * **Example** (Getting and updating atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -182,15 +189,16 @@ export const getAndSet = /*#__PURE__*/dual(2, (self, value) => modify(self, curr
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const getAndUpdate = /*#__PURE__*/dual(2, (self, f) => modify(self, current => [current, f(current)]));
 /**
  * Updates the value using a function and returns the new value. Publishes the
  * new value to all subscribers.
  *
- * @example
+ * **Example** (Updating and reading atomically)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef } from "effect"
  *
@@ -201,8 +209,8 @@ export const getAndUpdate = /*#__PURE__*/dual(2, (self, f) => modify(self, curre
  * })
  * ```
  *
- * @since 4.0.0
  * @category mutations
+ * @since 4.0.0
  */
 export const updateAndGet = /*#__PURE__*/dual(2, (self, f) => modify(self, current => {
   const newValue = f(current);
@@ -215,7 +223,8 @@ export const updateAndGet = /*#__PURE__*/dual(2, (self, f) => modify(self, curre
  * Subscribes to all changes of the TxSubscriptionRef. Returns a scoped TxDequeue
  * that first yields the current value, then every subsequent update.
  *
- * @example
+ * **Example** (Subscribing to changes)
+ *
  * ```ts
  * import { Effect, TxSubscriptionRef, TxQueue } from "effect"
  *
@@ -236,8 +245,8 @@ export const updateAndGet = /*#__PURE__*/dual(2, (self, f) => modify(self, curre
  * })
  * ```
  *
- * @since 4.0.0
  * @category subscriptions
+ * @since 4.0.0
  */
 export const changes = self => Effect.acquireRelease(Effect.tx(Effect.gen(function* () {
   const sub = yield* TxPubSub.acquireSubscriber(self.pubsub);
@@ -249,7 +258,8 @@ export const changes = self => Effect.acquireRelease(Effect.tx(Effect.gen(functi
  * Returns a Stream of all changes to the TxSubscriptionRef, starting with the
  * current value followed by every subsequent update.
  *
- * @example
+ * **Example** (Streaming changes)
+ *
  * ```ts
  * import { Effect, Stream, TxSubscriptionRef } from "effect"
  *
@@ -265,8 +275,8 @@ export const changes = self => Effect.acquireRelease(Effect.tx(Effect.gen(functi
  * })
  * ```
  *
- * @since 4.0.0
  * @category subscriptions
+ * @since 4.0.0
  */
 export const changesStream = self => Stream.unwrap(Effect.map(changes(self), sub => Stream.fromEffectRepeat(Effect.tx(TxQueue.take(sub)))));
 // =============================================================================
@@ -275,7 +285,8 @@ export const changesStream = self => Stream.unwrap(Effect.map(changes(self), sub
 /**
  * Checks if the given value is a TxSubscriptionRef.
  *
- * @example
+ * **Example** (Checking transactional subscription references)
+ *
  * ```ts
  * import { TxSubscriptionRef } from "effect"
  *
@@ -286,8 +297,8 @@ export const changesStream = self => Stream.unwrap(Effect.map(changes(self), sub
  * }
  * ```
  *
- * @since 4.0.0
  * @category guards
+ * @since 4.0.0
  */
 export const isTxSubscriptionRef = u => hasProperty(u, TypeId);
 //# sourceMappingURL=TxSubscriptionRef.js.map