effect 4.0.1 → 4.0.3

package/src/SynchronizedRef.ts

@@ -8,6 +8,7 @@
  * from concurrent updates. This module includes constructors, reads, writes,
  * updates, partial updates, and effectful update helpers.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Effect from "./Effect.ts"
@@ -32,6 +33,7 @@ const TypeId = "~effect/SynchronizedRef"
  *
  * @see {@link Ref.Ref} for a plain `Ref` when updates do not need effectful synchronization
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -60,6 +62,7 @@ const Proto = {
  * Use when you need synchronous `SynchronizedRef` construction outside an
  * Effect workflow.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -86,6 +89,7 @@ export const makeUnsafe = <A>(value: A): SynchronizedRef<A> => {
  * @see {@link makeUnsafe} for synchronous construction when the caller controls safe initialization
  * @see {@link Ref.make} for a plain `Ref` when updates do not need effectful synchronization
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -102,6 +106,7 @@ export const make = <A>(value: A): Effect.Effect<SynchronizedRef<A>> => Effect.s
  *
  * @see {@link get} for the Effect-wrapped read when composing inside Effect programs
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */
@@ -117,6 +122,7 @@ export const getUnsafe = <A>(self: SynchronizedRef<A>): A => self.backing.ref.cu
  *
  * @see {@link getUnsafe} for synchronous reads when the caller controls safe access outside `Effect`
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -135,6 +141,7 @@ export const get = <A>(self: SynchronizedRef<A>): Effect.Effect<A> => Effect.syn
  * @see {@link setAndGet} for setting a value and returning the new value
  * @see {@link getAndUpdate} for deriving the new value from the current value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -152,6 +159,7 @@ export const getAndSet: {
    * @see {@link setAndGet} for setting a value and returning the new value
    * @see {@link getAndUpdate} for deriving the new value from the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -169,6 +177,7 @@ export const getAndSet: {
    * @see {@link setAndGet} for setting a value and returning the new value
    * @see {@link getAndUpdate} for deriving the new value from the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -192,6 +201,7 @@ export const getAndSet: {
  * @see {@link updateAndGet} for updating and returning the new value
  * @see {@link getAndUpdateEffect} for effectful updates that return the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -209,6 +219,7 @@ export const getAndUpdate: {
    * @see {@link updateAndGet} for updating and returning the new value
    * @see {@link getAndUpdateEffect} for effectful updates that return the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -226,6 +237,7 @@ export const getAndUpdate: {
    * @see {@link updateAndGet} for updating and returning the new value
    * @see {@link getAndUpdateEffect} for effectful updates that return the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -251,6 +263,7 @@ export const getAndUpdate: {
  * @see {@link modifyEffect} for effectful updates with a custom return value
  * @see {@link getAndUpdateSomeEffect} for conditional effectful updates that return the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -270,6 +283,7 @@ export const getAndUpdateEffect: {
    * @see {@link modifyEffect} for effectful updates with a custom return value
    * @see {@link getAndUpdateSomeEffect} for conditional effectful updates that return the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -289,6 +303,7 @@ export const getAndUpdateEffect: {
    * @see {@link modifyEffect} for effectful updates with a custom return value
    * @see {@link getAndUpdateSomeEffect} for conditional effectful updates that return the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -318,6 +333,7 @@ export const getAndUpdateEffect: {
  * @see {@link getAndUpdate} for always applying a pure update
  * @see {@link updateSome} for applying a pure conditional update without returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -335,6 +351,7 @@ export const getAndUpdateSome: {
    * @see {@link getAndUpdate} for always applying a pure update
    * @see {@link updateSome} for applying a pure conditional update without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -352,6 +369,7 @@ export const getAndUpdateSome: {
    * @see {@link getAndUpdate} for always applying a pure update
    * @see {@link updateSome} for applying a pure conditional update without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -375,6 +393,7 @@ export const getAndUpdateSome: {
  * @see {@link getAndUpdateSome} for the pure conditional variant
  * @see {@link updateSomeEffect} for effectful conditional updates without returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -392,6 +411,7 @@ export const getAndUpdateSomeEffect: {
    * @see {@link getAndUpdateSome} for the pure conditional variant
    * @see {@link updateSomeEffect} for effectful conditional updates without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -409,6 +429,7 @@ export const getAndUpdateSomeEffect: {
    * @see {@link getAndUpdateSome} for the pure conditional variant
    * @see {@link updateSomeEffect} for effectful conditional updates without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -444,6 +465,7 @@ export const getAndUpdateSomeEffect: {
  * @see {@link modifySome} for deriving a result and optionally updating the stored value
  * @see {@link updateAndGet} for returning the new stored value instead of a separate result
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -461,6 +483,7 @@ export const modify: {
    * @see {@link modifySome} for deriving a result and optionally updating the stored value
    * @see {@link updateAndGet} for returning the new stored value instead of a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -478,6 +501,7 @@ export const modify: {
    * @see {@link modifySome} for deriving a result and optionally updating the stored value
    * @see {@link updateAndGet} for returning the new stored value instead of a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -500,6 +524,7 @@ export const modify: {
  * @see {@link modify} for the pure variant
  * @see {@link updateEffect} for effectfully storing a new value without a separate result
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -516,6 +541,7 @@ export const modifyEffect: {
    * @see {@link modify} for the pure variant
    * @see {@link updateEffect} for effectfully storing a new value without a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -532,6 +558,7 @@ export const modifyEffect: {
    * @see {@link modify} for the pure variant
    * @see {@link updateEffect} for effectfully storing a new value without a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -563,6 +590,7 @@ export const modifyEffect: {
  * @see {@link modify} for always storing a new value
  * @see {@link updateSome} for optional updates without a separate return value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -579,6 +607,7 @@ export const modifySome: {
    * @see {@link modify} for always storing a new value
    * @see {@link updateSome} for optional updates without a separate return value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -595,6 +624,7 @@ export const modifySome: {
    * @see {@link modify} for always storing a new value
    * @see {@link updateSome} for optional updates without a separate return value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -620,6 +650,7 @@ export const modifySome: {
  * @see {@link modifySome} for the pure variant
  * @see {@link updateSomeEffect} for effectful optional updates without a separate return value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -637,6 +668,7 @@ export const modifySomeEffect: {
    * @see {@link modifySome} for the pure variant
    * @see {@link updateSomeEffect} for effectful optional updates without a separate return value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -654,6 +686,7 @@ export const modifySomeEffect: {
    * @see {@link modifySome} for the pure variant
    * @see {@link updateSomeEffect} for effectful optional updates without a separate return value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -691,6 +724,7 @@ export const modifySomeEffect: {
  * @see {@link setAndGet} for replacing the value when the new value should be returned
  * @see {@link update} for deriving the next value from the current value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -707,6 +741,7 @@ export const set: {
    * @see {@link setAndGet} for replacing the value when the new value should be returned
    * @see {@link update} for deriving the next value from the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -723,6 +758,7 @@ export const set: {
    * @see {@link setAndGet} for replacing the value when the new value should be returned
    * @see {@link update} for deriving the next value from the current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -744,6 +780,7 @@ export const set: {
  * @see {@link set} for setting without returning a value
  * @see {@link getAndSet} for setting while returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -759,6 +796,7 @@ export const setAndGet: {
    * @see {@link set} for setting without returning a value
    * @see {@link getAndSet} for setting while returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -774,6 +812,7 @@ export const setAndGet: {
    * @see {@link set} for setting without returning a value
    * @see {@link getAndSet} for setting while returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -797,6 +836,7 @@ export const setAndGet: {
  * @see {@link updateAndGet} for returning the new stored value
  * @see {@link getAndUpdate} for returning the previous stored value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -814,6 +854,7 @@ export const update: {
    * @see {@link updateAndGet} for returning the new stored value
    * @see {@link getAndUpdate} for returning the previous stored value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -831,6 +872,7 @@ export const update: {
    * @see {@link updateAndGet} for returning the new stored value
    * @see {@link getAndUpdate} for returning the previous stored value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -856,6 +898,7 @@ export const update: {
  * @see {@link modifyEffect} for returning a separate result while storing a new value
  * @see {@link updateSomeEffect} for effectfully applying only some state transitions
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -875,6 +918,7 @@ export const updateEffect: {
    * @see {@link modifyEffect} for returning a separate result while storing a new value
    * @see {@link updateSomeEffect} for effectfully applying only some state transitions
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -894,6 +938,7 @@ export const updateEffect: {
    * @see {@link modifyEffect} for returning a separate result while storing a new value
    * @see {@link updateSomeEffect} for effectfully applying only some state transitions
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -921,6 +966,7 @@ export const updateEffect: {
  * @see {@link update} for updating without returning the new value
  * @see {@link getAndUpdate} for updating while returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -937,6 +983,7 @@ export const updateAndGet: {
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for updating while returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -953,6 +1000,7 @@ export const updateAndGet: {
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for updating while returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -975,6 +1023,7 @@ export const updateAndGet: {
  * @see {@link updateEffect} for effectful updates without returning the new value
  * @see {@link updateAndGet} for the pure variant
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -991,6 +1040,7 @@ export const updateAndGetEffect: {
    * @see {@link updateEffect} for effectful updates without returning the new value
    * @see {@link updateAndGet} for the pure variant
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1007,6 +1057,7 @@ export const updateAndGetEffect: {
    * @see {@link updateEffect} for effectful updates without returning the new value
    * @see {@link updateAndGet} for the pure variant
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1035,6 +1086,7 @@ export const updateAndGetEffect: {
  * @see {@link update} for always applying a pure update
  * @see {@link updateSomeAndGet} for returning the resulting current value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1051,6 +1103,7 @@ export const updateSome: {
    * @see {@link update} for always applying a pure update
    * @see {@link updateSomeAndGet} for returning the resulting current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1067,6 +1120,7 @@ export const updateSome: {
    * @see {@link update} for always applying a pure update
    * @see {@link updateSomeAndGet} for returning the resulting current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1089,6 +1143,7 @@ export const updateSome: {
  * @see {@link updateSome} for the pure conditional variant
  * @see {@link updateEffect} for effectful updates that always store a new value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1105,6 +1160,7 @@ export const updateSomeEffect: {
    * @see {@link updateSome} for the pure conditional variant
    * @see {@link updateEffect} for effectful updates that always store a new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1121,6 +1177,7 @@ export const updateSomeEffect: {
    * @see {@link updateSome} for the pure conditional variant
    * @see {@link updateEffect} for effectful updates that always store a new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1155,6 +1212,7 @@ export const updateSomeEffect: {
  * @see {@link updateSome} for conditional updates without returning a value
  * @see {@link updateAndGet} for always applying a pure update and returning the new value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1172,6 +1230,7 @@ export const updateSomeAndGet: {
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always applying a pure update and returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1189,6 +1248,7 @@ export const updateSomeAndGet: {
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always applying a pure update and returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1212,6 +1272,7 @@ export const updateSomeAndGet: {
  * @see {@link updateSomeEffect} for effectful conditional updates without returning a value
  * @see {@link updateAndGetEffect} for effectful updates that always store and return a new value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1229,6 +1290,7 @@ export const updateSomeAndGetEffect: {
    * @see {@link updateSomeEffect} for effectful conditional updates without returning a value
    * @see {@link updateAndGetEffect} for effectful updates that always store and return a new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1246,6 +1308,7 @@ export const updateSomeAndGetEffect: {
    * @see {@link updateSomeEffect} for effectful conditional updates without returning a value
    * @see {@link updateAndGetEffect} for effectful updates that always store and return a new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */

package/src/Take.ts

@@ -4,6 +4,7 @@
  * emitted values, a failed `Exit`, or a successful `Exit` carrying the
  * completion value.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type { NonEmptyReadonlyArray } from "./Array.ts"
@@ -23,6 +24,7 @@ import type * as Pull from "./Pull.ts"
  *
  * @see {@link toPull} for interpreting a `Take` as a `Pull` step
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -37,6 +39,7 @@ export type Take<A, E = never, Done = void> = NonEmptyReadonlyArray<A> | Exit.Ex
  * Use to interpret a stored or transferred `Take` as a `Pull` step while
  * preserving emitted batches, ordinary failures, and completion values.
  *
+ * @stability stable
  * @category converting
  * @since 4.0.0
  */

package/src/Terminal.ts

@@ -7,6 +7,7 @@
  * the `QuitError` used when a user cancels input, a guard for that error, and a
  * constructor for custom terminal service implementations.
  *
+ * @stability unstable
  * @since 4.0.0
  */
 import type * as Cause from "./Cause.ts"
@@ -25,6 +26,7 @@ const TypeId = "~effect/Terminal"
  * A `Terminal` represents a command-line interface which can read input from a
  * user and display messages to a user.
  *
+ * @stability unstable
  * @category services
  * @since 4.0.0
  */
@@ -58,6 +60,7 @@ export interface Terminal {
  * Keyboard key metadata for terminal input, including the key name and
  * modifier state.
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -91,6 +94,7 @@ export interface Key {
  *
  * @see {@link Key} for the parsed key metadata stored on each input event
  *
+ * @stability unstable
  * @category models
  * @since 4.0.0
  */
@@ -118,6 +122,7 @@ const QuitErrorTypeId = "~effect/Terminal/QuitError"
  *
  * @see {@link isQuitError} for checking unknown errors when handling terminal cancellation
  *
+ * @stability unstable
  * @category errors
  * @since 4.0.0
  */
@@ -147,6 +152,7 @@ export class QuitError extends Schema.Error<QuitError>("QuitError")({
  *
  * @see {@link QuitError} for the error value produced when terminal input is quit
  *
+ * @stability unstable
  * @category guards
  * @since 4.0.0
  */
@@ -160,6 +166,7 @@ export const isQuitError = (u: unknown): u is QuitError => Predicate.hasProperty
  * Use to access or provide platform terminal capabilities such as reading
  * input, writing output, and inspecting terminal dimensions.
  *
+ * @stability unstable
  * @category services
  * @since 4.0.0
  */
@@ -180,6 +187,7 @@ export const Terminal: Context.Service<Terminal, Terminal> = Context.Service("ef
  * `readLine`, and `display`; `make` attaches the `Terminal` service marker so
  * the result can be provided through the `Terminal` context service.
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */