effect 4.0.1 → 4.0.3

package/src/Redactable.ts

@@ -6,6 +6,7 @@
  * Typical use cases include masking secrets, tokens, or personal data in logs, traces,
  * and serialized output.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import type * as Context from "./Context.ts"
@@ -45,6 +46,7 @@ import { hasProperty } from "./Predicate.ts"
  *
  * @see {@link Redactable} for the interface this symbol belongs to
  * @see {@link isRedactable} to check whether a value has this symbol
+ * @stability stable
  * @category symbols
  * @since 3.10.0
  */
@@ -82,6 +84,7 @@ export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
  * @see {@link symbolRedactable} for the symbol key to implement
  * @see {@link redact} to apply redaction to any value
  * @see {@link isRedactable} for the type guard for this interface
+ * @stability stable
  * @category models
  * @since 3.10.0
  */
@@ -99,6 +102,7 @@ export interface Redactable {
  *
  * @see {@link Redactable} for the interface being checked
  * @see {@link redact} to apply redaction if the value is redactable
+ * @stability stable
  * @category guards
  * @since 3.10.0
  */
@@ -125,6 +129,7 @@ export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symb
  *
  * @see {@link isRedactable} to check before redacting
  * @see {@link getRedacted} for the lower-level variant for known redactables
+ * @stability stable
  * @category destructors
  * @since 3.10.0
  */
@@ -153,6 +158,7 @@ export function redact(u: unknown): unknown {
  *
  * @see {@link redact} for the higher-level variant that handles non-redactable values
  * @see {@link isRedactable} for the type guard to verify before calling this
+ * @stability stable
  * @category destructors
  * @since 4.0.0
  */

package/src/Redacted.ts

@@ -8,6 +8,7 @@
  * values, and comparison helpers that avoid exposing the wrapped value at the
  * call site.
  *
+ * @stability stable
  * @since 3.3.0
  */
 import * as Equal from "./Equal.ts"
@@ -50,6 +51,7 @@ const TypeId = "~effect/Redacted"
  * Array.of(String(apiKey), String(userPassword)) // => ["<redacted>", "<redacted>"]
  * ```
  *
+ * @stability stable
  * @category models
  * @since 3.3.0
  */
@@ -76,6 +78,7 @@ export interface Redacted<out A = string> extends Redacted.Variance<A>, Equal.Eq
  * Redacted.isRedacted(secret) // => true
  * ```
  *
+ * @stability stable
  * @since 3.3.0
  */
 export declare namespace Redacted {
@@ -153,6 +156,7 @@ export declare namespace Redacted {
  * Redacted.isRedacted(plainString) // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 3.3.0
  */
@@ -181,6 +185,7 @@ export const isRedacted = (u: unknown): u is Redacted<unknown> => hasProperty(u,
  * String(API_KEY) // => "<redacted>"
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 3.3.0
  */
@@ -239,6 +244,7 @@ const Proto = {
  * Redacted.value(API_KEY) // => "1234567890"
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 3.3.0
  */
@@ -277,6 +283,7 @@ export const value: <T>(self: Redacted<T>) => T = redacted.value
  * failure // => Result.fail("Unable to get redacted value")
  * ```
  *
+ * @stability stable
  * @category unsafe
  * @since 4.0.0
  */
@@ -307,6 +314,7 @@ export const wipeUnsafe = <T>(self: Redacted<T>): boolean => redacted.redactedRe
  * equivalence(API_KEY1, API_KEY3) // => true
  * ```
  *
+ * @stability stable
  * @category instances
  * @since 4.0.0
  */

package/src/Reducer.ts

@@ -5,6 +5,7 @@
  * constructor for reducers and a helper for reversing the order in which values
  * are combined.
  *
+ * @stability stable
  * @since 4.0.0
  */
 
@@ -48,6 +49,7 @@ import type * as Combiner from "./Combiner.ts"
  * @see {@link make} – create a `Reducer` from a function and initial value
  * @see {@link Combiner.Combiner} – parent interface without `initialValue`
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -111,6 +113,7 @@ export interface Reducer<A> extends Combiner.Combiner<A> {
  * @see {@link Reducer} – the interface this creates
  * @see {@link flip} – reverse the argument order
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -163,6 +166,7 @@ export function make<A>(
  * @see {@link make}
  * @see {@link Combiner.flip} – the same operation on a plain `Combiner`
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */

package/src/Ref.ts

@@ -8,6 +8,7 @@
  * update variants that leave the value unchanged when an `Option.none` result
  * is returned.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as Effect from "./Effect.ts"
@@ -53,6 +54,7 @@ const TypeId = "~effect/Ref"
  * @see {@link get} for reading the current value
  * @see {@link set} for replacing the current value
  *
+ * @stability stable
  * @category models
  * @since 2.0.0
  */
@@ -67,6 +69,7 @@ export interface Ref<in out A> extends Ref.Variance<A>, Pipeable {
  *
  * Use when referring to type members nested under the `Ref` namespace.
  *
+ * @stability stable
  * @since 2.0.0
  */
 export declare namespace Ref {
@@ -136,6 +139,7 @@ const RefProto = {
  * Ref.getUnsafe(counter) // => 0
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -167,6 +171,7 @@ export const makeUnsafe = <A>(value: A): Ref<A> => {
  *
  * @see {@link makeUnsafe} for synchronous construction outside Effect code
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -194,6 +199,7 @@ export const make = <A>(value: A): Effect.Effect<Ref<A>> => Effect.sync(() => ma
  *
  * @see {@link set} for replacing the current value
  *
+ * @stability stable
  * @category getters
  * @since 2.0.0
  */
@@ -230,6 +236,7 @@ export const get = <A>(self: Ref<A>) => Effect.sync(() => self.ref.current)
  * @see {@link getAndSet} for setting while returning the previous value
  * @see {@link setAndGet} for setting while returning the new value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -265,6 +272,7 @@ export const set = dual<
    * @see {@link getAndSet} for setting while returning the previous value
    * @see {@link setAndGet} for setting while returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -300,6 +308,7 @@ export const set = dual<
    * @see {@link getAndSet} for setting while returning the previous value
    * @see {@link setAndGet} for setting while returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -332,6 +341,7 @@ export const set = dual<
  * @see {@link set} for setting without returning the previous value
  * @see {@link getAndUpdate} for deriving the new value from the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -362,6 +372,7 @@ export const getAndSet = dual<
    * @see {@link set} for setting without returning the previous value
    * @see {@link getAndUpdate} for deriving the new value from the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -392,6 +403,7 @@ export const getAndSet = dual<
    * @see {@link set} for setting without returning the previous value
    * @see {@link getAndUpdate} for deriving the new value from the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -429,6 +441,7 @@ export const getAndSet = dual<
  * @see {@link update} for updating without returning the previous value
  * @see {@link updateAndGet} for returning the new value instead
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -459,6 +472,7 @@ export const getAndUpdate = dual<
    * @see {@link update} for updating without returning the previous value
    * @see {@link updateAndGet} for returning the new value instead
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -489,6 +503,7 @@ export const getAndUpdate = dual<
    * @see {@link update} for updating without returning the previous value
    * @see {@link updateAndGet} for returning the new value instead
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -540,6 +555,7 @@ export const getAndUpdate = dual<
  * @see {@link getAndUpdate} for always applying an update
  * @see {@link updateSome} for conditional updates without returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -584,6 +600,7 @@ export const getAndUpdateSome = dual<
    * @see {@link getAndUpdate} for always applying an update
    * @see {@link updateSome} for conditional updates without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -628,6 +645,7 @@ export const getAndUpdateSome = dual<
    * @see {@link getAndUpdate} for always applying an update
    * @see {@link updateSome} for conditional updates without returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -672,6 +690,7 @@ export const getAndUpdateSome = dual<
  * await Effect.runPromise(program2) // => 20
  * ```
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -706,6 +725,7 @@ export const setAndGet = dual<
    * await Effect.runPromise(program2) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -740,6 +760,7 @@ export const setAndGet = dual<
    * await Effect.runPromise(program2) // => 20
    * ```
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -791,6 +812,7 @@ export const setAndGet = dual<
  * @see {@link updateAndGet} for returning the new stored value
  * @see {@link modifySome} for optionally updating while returning a separate result
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -840,6 +862,7 @@ export const modify = dual<
    * @see {@link updateAndGet} for returning the new stored value
    * @see {@link modifySome} for optionally updating while returning a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -889,6 +912,7 @@ export const modify = dual<
    * @see {@link updateAndGet} for returning the new stored value
    * @see {@link modifySome} for optionally updating while returning a separate result
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -947,6 +971,7 @@ export const modify = dual<
  * @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
  */
@@ -998,6 +1023,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
    */
@@ -1049,6 +1075,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
    */
@@ -1101,6 +1128,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
    */
@@ -1152,6 +1180,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
    */
@@ -1194,6 +1223,7 @@ export const modifySome: {
  * @see {@link updateAndGet} for returning the new value
  * @see {@link getAndUpdate} for returning the previous value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1230,6 +1260,7 @@ export const update = dual<
    * @see {@link updateAndGet} for returning the new value
    * @see {@link getAndUpdate} for returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1266,6 +1297,7 @@ export const update = dual<
    * @see {@link updateAndGet} for returning the new value
    * @see {@link getAndUpdate} for returning the previous value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1301,6 +1333,7 @@ export const update = dual<
  * @see {@link update} for updating without returning the new value
  * @see {@link getAndUpdate} for returning the previous value instead
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1331,6 +1364,7 @@ export const updateAndGet = dual<
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for returning the previous value instead
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1361,6 +1395,7 @@ export const updateAndGet = dual<
    * @see {@link update} for updating without returning the new value
    * @see {@link getAndUpdate} for returning the previous value instead
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1407,6 +1442,7 @@ export const updateAndGet = dual<
  * @see {@link update} for always applying an update
  * @see {@link updateSomeAndGet} for returning the resulting current value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1451,6 +1487,7 @@ export const updateSome = dual<
    * @see {@link update} for always applying an update
    * @see {@link updateSomeAndGet} for returning the resulting current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1495,6 +1532,7 @@ export const updateSome = dual<
    * @see {@link update} for always applying an update
    * @see {@link updateSomeAndGet} for returning the resulting current value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1546,6 +1584,7 @@ export const updateSome = dual<
  * @see {@link updateSome} for conditional updates without returning a value
  * @see {@link updateAndGet} for always updating and returning the new value
  *
+ * @stability stable
  * @category mutations
  * @since 2.0.0
  */
@@ -1589,6 +1628,7 @@ export const updateSomeAndGet = dual<
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always updating and returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1632,6 +1672,7 @@ export const updateSomeAndGet = dual<
    * @see {@link updateSome} for conditional updates without returning a value
    * @see {@link updateAndGet} for always updating and returning the new value
    *
+   * @stability stable
    * @category mutations
    * @since 2.0.0
    */
@@ -1666,6 +1707,7 @@ export const updateSomeAndGet = dual<
  * Ref.getUnsafe(counter) // => 42
  * ```
  *
+ * @stability stable
  * @category getters
  * @since 4.0.0
  */

package/src/References.ts

@@ -9,6 +9,7 @@
  * providing a new value changes behavior for the provided effect and the fibers
  * it starts.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import type * as Context from "./Context.ts"
@@ -31,6 +32,7 @@ export {
    *
    * @see {@link MinimumTraceLevel} for configuring the threshold that decides whether spans at a given level are sampled or exported
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -50,6 +52,7 @@ export {
    *
    * @see {@link TracerEnabled} for disabling span registration instead of only propagation
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -68,6 +71,7 @@ export {
    *
    * @see {@link PreventSchedulerYield} for bypassing scheduler yield checks instead of changing the operation budget
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -82,6 +86,7 @@ export {
    *
    * @see {@link CurrentTraceLevel} for setting the level assigned to spans before this threshold is applied
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -106,6 +111,7 @@ export {
    *
    * @see {@link MaxOpsBeforeYield} for tuning the operation budget while keeping scheduler yield checks enabled
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -118,6 +124,7 @@ export {
    * Use to access or override the active tracer service through the references
    * module when working directly with Effect runtime references.
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */
@@ -179,6 +186,7 @@ export {
  * await Effect.runPromise(logAnnotationExample) // => [0, ["req-123", "user-456", "1.0.0"], ["data-sync", 1234567890]]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -219,6 +227,7 @@ export const CurrentLogAnnotations: Context.Reference<ReadonlyRecord<string, unk
  * levels // => ["Info", "Error"]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -284,6 +293,7 @@ export const CurrentLogLevel: Context.Reference<Severity> = references.CurrentLo
  * await Effect.runPromise(logSpanExample) // => [0, ["database-connection"], ["database-connection", "data-processing"], 0]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -307,6 +317,7 @@ export const CurrentLogSpans: Context.Reference<ReadonlyArray<[label: string, ti
  *
  * @see {@link StackFrame} for the frame node stored in this reference
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -343,6 +354,7 @@ export const CurrentStackFrame: Context.Reference<StackFrame | undefined> = refe
  * levels // => ["Warn", "Error"]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -385,6 +397,7 @@ export const MinimumLogLevel: Context.Reference<LogLevel> = references.MinimumLo
  * await Effect.runPromise(tracingControl) // => [true, false, true]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -439,6 +452,7 @@ export const TracerEnabled: Context.Reference<boolean> = references.TracerEnable
  * await Effect.runPromise(spanAnnotationExample) // => [0, ["user-service", "1.2.3", "production"], 0]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -498,6 +512,7 @@ export const TracerSpanAnnotations: Context.Reference<ReadonlyRecord<string, unk
  * await Effect.runPromise(spanLinksExample) // => [0, 1, 0]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -541,6 +556,7 @@ export const TracerSpanLinks: Context.Reference<ReadonlyArray<SpanLink>> = refer
  * await Effect.runPromise(tracingControl) // => [true, false, true]
  * ```
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -567,6 +583,7 @@ export const TracerTimingEnabled: Context.Reference<boolean> = references.Tracer
  * @see {@link CurrentLogLevel} for the default severity used by ordinary `Effect.log` calls
  * @see {@link MinimumLogLevel} for filtering emitted log entries by threshold
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -587,6 +604,7 @@ export const UnhandledLogLevel: Context.Reference<Severity | undefined> = refere
  *
  * @see {@link CurrentStackFrame} for the fiber reference carrying the active stack-frame chain
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -611,6 +629,7 @@ export interface StackFrame {
  * Providing this reference changes which `Logger` instances receive log entries
  * in the current context.
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -629,6 +648,7 @@ export const CurrentLoggers: Context.Reference<ReadonlySet<Logger<unknown, any>>
  * The default value is `false`. When set to `true`, the built-in default logger
  * and TTY pretty console logger call `console.error` instead of `console.log`.
  *
+ * @stability stable
  * @category references
  * @since 4.0.0
  */
@@ -667,6 +687,7 @@ export {
    * await Effect.runPromise(customScheduling) // => [true, true]
    * ```
    *
+   * @stability stable
    * @category references
    * @since 4.0.0
    */

package/src/RegExp.ts

@@ -8,6 +8,7 @@
  * data-driven text, check whether an unknown value is already a `RegExp`, or
  * access the native constructor without leaving the Effect namespace.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import * as predicate from "./Predicate.ts"
@@ -31,6 +32,7 @@ import * as predicate from "./Predicate.ts"
  * pattern.test("goodbye") // => false
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -52,6 +54,7 @@ export const RegExp = globalThis.RegExp
  * RegExp.isRegExp("a") // => false
  * ```
  *
+ * @stability stable
  * @category guards
  * @since 3.9.0
  */
@@ -72,6 +75,7 @@ export const isRegExp: (input: unknown) => input is RegExp = predicate.isRegExp
  * RegExp.escape("a*b") // => "a\\*b"
  * ```
  *
+ * @stability stable
  * @category transforming
  * @since 2.0.0
  */