effect 4.0.0 → 4.0.2

package/src/SubscriptionRef.ts

@@ -7,6 +7,7 @@
  * module includes constructors, current-value reads, the `changes` stream,
  * writes, updates, partial updates, and effectful update helpers.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Effect from "./Effect.ts"
@@ -31,6 +32,7 @@ const TypeId = "~effect/SubscriptionRef"
  * Use to observe the current value and subsequent updates as a
  * stream.
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -48,6 +50,7 @@ export interface SubscriptionRef<in out A> extends SubscriptionRef.Variance<A>,
  * Use to narrow an unknown value before calling `SubscriptionRef` operations
  * that require a subscription reference.
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -59,6 +62,7 @@ export const isSubscriptionRef: (u: unknown) => u is SubscriptionRef<unknown> =
  * The `SubscriptionRef` namespace containing type definitions associated with
  * subscription references.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace SubscriptionRef {
@@ -105,6 +109,7 @@ const Proto = {
  * @see {@link changes} for streaming the current value and subsequent updates
  * @see {@link set} for replacing the value and notifying subscribers
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -154,6 +159,7 @@ export const make = <A>(value: A): Effect.Effect<SubscriptionRef<A>> =>
  * await Effect.runPromise(program) // => [0, 1, 2]
  * ```
  *
+ * @stability stable
  * @category subscriptions
  * @since 4.0.0
  */
@@ -187,6 +193,7 @@ export const changes = <A>(self: SubscriptionRef<A>): Stream.Stream<A> => Stream
  * await Effect.runPromise(program) // => 42
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -209,6 +216,7 @@ export const getUnsafe = <A>(self: SubscriptionRef<A>): A => self.value
  * await Effect.runPromise(program) // => 42
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -234,6 +242,7 @@ export const get = <A>(self: SubscriptionRef<A>): Effect.Effect<A> => Effect.syn
  * await Effect.runPromise(program) // => [10, 20]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -258,6 +267,7 @@ export const getAndSet: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -282,6 +292,7 @@ export const getAndSet: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -318,6 +329,7 @@ const setUnsafe = <A>(self: SubscriptionRef<A>, value: A) => {
  * await Effect.runPromise(program) // => [10, 20]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -342,6 +354,7 @@ export const getAndUpdate: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -366,6 +379,7 @@ export const getAndUpdate: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -401,6 +415,7 @@ export const getAndUpdate: {
  * await Effect.runPromise(program) // => [10, 15]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -428,6 +443,7 @@ export const getAndUpdateEffect: {
    * await Effect.runPromise(program) // => [10, 15]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -455,6 +471,7 @@ export const getAndUpdateEffect: {
    * await Effect.runPromise(program) // => [10, 15]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -504,6 +521,7 @@ export const getAndUpdateEffect: {
  * await Effect.runPromise(program) // => [10, 20]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -541,6 +559,7 @@ export const getAndUpdateSome: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -578,6 +597,7 @@ export const getAndUpdateSome: {
    * await Effect.runPromise(program) // => [10, 20]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -629,6 +649,7 @@ export const getAndUpdateSome: {
  * await Effect.runPromise(program) // => [10, 13]
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -666,6 +687,7 @@ export const getAndUpdateSomeEffect: {
    * await Effect.runPromise(program) // => [10, 13]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -703,6 +725,7 @@ export const getAndUpdateSomeEffect: {
    * await Effect.runPromise(program) // => [10, 13]
    * ```
    *
+   * @stability stable
    * @category getters
    * @since 2.0.0
    */
@@ -746,6 +769,7 @@ export const getAndUpdateSomeEffect: {
  * await Effect.runPromise(program) // => ["Old value was 10", 20]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -773,6 +797,7 @@ export const modify: {
    * await Effect.runPromise(program) // => ["Old value was 10", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -800,6 +825,7 @@ export const modify: {
    * await Effect.runPromise(program) // => ["Old value was 10", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -838,6 +864,7 @@ export const modify: {
  * await Effect.runPromise(program) // => ["Doubled from 10", 20]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -866,6 +893,7 @@ export const modifyEffect: {
    * await Effect.runPromise(program) // => ["Doubled from 10", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -894,6 +922,7 @@ export const modifyEffect: {
    * await Effect.runPromise(program) // => ["Doubled from 10", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -946,6 +975,7 @@ export const modifyEffect: {
  * await Effect.runPromise(program) // => ["Updated", 20]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -984,6 +1014,7 @@ export const modifySome: {
    * await Effect.runPromise(program) // => ["Updated", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1022,6 +1053,7 @@ export const modifySome: {
    * await Effect.runPromise(program) // => ["Updated", 20]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1075,6 +1107,7 @@ export const modifySome: {
  * await Effect.runPromise(program) // => ["Updated", 15]
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1117,6 +1150,7 @@ export const modifySomeEffect: {
    * await Effect.runPromise(program) // => ["Updated", 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1159,6 +1193,7 @@ export const modifySomeEffect: {
    * await Effect.runPromise(program) // => ["Updated", 15]
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1198,6 +1233,7 @@ export const modifySomeEffect: {
  * await Effect.runPromise(program) // => 42
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1222,6 +1258,7 @@ export const set: {
    * await Effect.runPromise(program) // => 42
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1246,6 +1283,7 @@ export const set: {
    * await Effect.runPromise(program) // => 42
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1273,6 +1311,7 @@ export const set: {
  * await Effect.runPromise(program) // => 42
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1295,6 +1334,7 @@ export const setAndGet: {
    * await Effect.runPromise(program) // => 42
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1317,6 +1357,7 @@ export const setAndGet: {
    * await Effect.runPromise(program) // => 42
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1347,6 +1388,7 @@ export const setAndGet: {
  * await Effect.runPromise(program) // => 20
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1371,6 +1413,7 @@ export const update: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1395,6 +1438,7 @@ export const update: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1425,6 +1469,7 @@ export const update: {
  * await Effect.runPromise(program) // => 15
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1449,6 +1494,7 @@ export const updateEffect: {
    * await Effect.runPromise(program) // => 15
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1473,6 +1519,7 @@ export const updateEffect: {
    * await Effect.runPromise(program) // => 15
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1503,6 +1550,7 @@ export const updateEffect: {
  * await Effect.runPromise(program) // => 20
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1525,6 +1573,7 @@ export const updateAndGet: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1547,6 +1596,7 @@ export const updateAndGet: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1580,6 +1630,7 @@ export const updateAndGet: {
  * await Effect.runPromise(program) // => 15
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1606,6 +1657,7 @@ export const updateAndGetEffect: {
    * await Effect.runPromise(program) // => 15
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1632,6 +1684,7 @@ export const updateAndGetEffect: {
    * await Effect.runPromise(program) // => 15
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1671,6 +1724,7 @@ export const updateAndGetEffect: {
  * await Effect.runPromise(program) // => 20
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1699,6 +1753,7 @@ export const updateSome: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1727,6 +1782,7 @@ export const updateSome: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1774,6 +1830,7 @@ export const updateSome: {
  * await Effect.runPromise(program) // => 13
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1811,6 +1868,7 @@ export const updateSomeEffect: {
    * await Effect.runPromise(program) // => 13
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1848,6 +1906,7 @@ export const updateSomeEffect: {
    * await Effect.runPromise(program) // => 13
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1897,6 +1956,7 @@ export const updateSomeEffect: {
  * await Effect.runPromise(program) // => 20
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1932,6 +1992,7 @@ export const updateSomeAndGet: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1967,6 +2028,7 @@ export const updateSomeAndGet: {
    * await Effect.runPromise(program) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -2014,6 +2076,7 @@ export const updateSomeAndGet: {
  * await Effect.runPromise(program) // => 13
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -2049,6 +2112,7 @@ export const updateSomeAndGetEffect: {
    * await Effect.runPromise(program) // => 13
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -2084,6 +2148,7 @@ export const updateSomeAndGetEffect: {
    * await Effect.runPromise(program) // => 13
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */

package/src/Symbol.ts

@@ -4,6 +4,7 @@
  * and must be narrowed before it can be used as a symbol key, identifier, or
  * discriminant.
  *
+ * @stability stable
  * @since 2.0.0
  */
 
@@ -25,6 +26,7 @@ import * as predicate from "./Predicate.ts"
  * Symbol.isSymbol("a") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 2.0.0
  */