effect 4.0.1 → 4.0.3

package/src/ConfigProvider.ts

@@ -6,6 +6,7 @@
  * for composing providers, changing paths, and installing providers through
  * layers.
  *
+ * @stability stable
  * @since 4.0.0
  */
 
@@ -50,6 +51,7 @@ import * as Str from "./String.ts"
  * @see {@link makeRecord} – construct a `Record` node
  * @see {@link makeArray} – construct an `Array` node
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -95,6 +97,7 @@ export type Node =
  * @see {@link makeRecord} – for object-like containers
  * @see {@link makeArray} – for array-like containers
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -133,6 +136,7 @@ export function makeValue(value: string): Node {
  * @see {@link makeValue} – for terminal leaves
  * @see {@link makeArray} – for array-like containers
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -165,6 +169,7 @@ export function makeRecord(keys: ReadonlySet<string>, value?: string): Node {
  * @see {@link makeValue} – for terminal leaves
  * @see {@link makeRecord} – for object-like containers
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -202,6 +207,7 @@ export function makeArray(length: number, value?: string): Node {
  * @see {@link ConfigProvider} – the interface whose `load` may fail with this
  *   error
  *
+ * @stability stable
  * @category errors
  * @since 4.0.0
  */
@@ -229,6 +235,7 @@ export class SourceError extends Data.TaggedError("SourceError")<{
  * path.join(".") // => "database.replicas.0.host"
  * ```
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -264,6 +271,7 @@ export type Path = ReadonlyArray<string | number>
  * @see {@link make} – construct a provider from a lookup function
  * @see {@link orElse} – compose providers with fallback
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -336,6 +344,7 @@ export interface ConfigProvider extends Pipeable {
  * @see {@link layer} – install a provider as a Layer
  * @see {@link layerAdd} – add a fallback provider as a Layer
  *
+ * @stability stable
  * @category services
  * @since 4.0.0
  */
@@ -429,6 +438,7 @@ function makeOrElse(first: ConfigProvider, second: ConfigProvider): ConfigProvid
  * @see {@link fromEnv} – pre-built provider for environment variables
  * @see {@link fromUnknown} – pre-built provider for JSON objects
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -475,6 +485,7 @@ export function make(get: (path: Path) => Effect.Effect<Node | undefined, Source
  *
  * @see {@link layerAdd} – install a fallback provider via a Layer
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -518,6 +529,7 @@ export const orElse: {
    *
    * @see {@link layerAdd} – install a fallback provider via a Layer
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -561,6 +573,7 @@ export const orElse: {
    *
    * @see {@link layerAdd} – install a fallback provider via a Layer
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -612,6 +625,7 @@ export const orElse: {
  * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
  * @see {@link nested} – for prepending a prefix instead of transforming
  *
+ * @stability stable
  * @category combinators
  * @since 4.0.0
  */
@@ -658,6 +672,7 @@ export const mapInput: {
    * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
    * @see {@link nested} – for prepending a prefix instead of transforming
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -704,6 +719,7 @@ export const mapInput: {
    * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
    * @see {@link nested} – for prepending a prefix instead of transforming
    *
+   * @stability stable
    * @category combinators
    * @since 4.0.0
    */
@@ -743,6 +759,7 @@ export const mapInput: {
  *
  * @see {@link mapInput} – for arbitrary path transformations
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -789,6 +806,7 @@ export const constantCase: (self: ConfigProvider) => ConfigProvider = mapInput((
  *
  * @see {@link mapInput} – for arbitrary path transformations
  *
+ * @stability stable
  * @category combinators
  * @since 2.0.0
  */
@@ -832,6 +850,7 @@ export const nested: {
    *
    * @see {@link mapInput} – for arbitrary path transformations
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -875,6 +894,7 @@ export const nested: {
    *
    * @see {@link mapInput} – for arbitrary path transformations
    *
+   * @stability stable
    * @category combinators
    * @since 2.0.0
    */
@@ -919,6 +939,7 @@ export const nested: {
  *
  * @see {@link layerAdd} – add a provider without replacing the existing one
  *
+ * @stability stable
  * @category layers
  * @since 4.0.0
  */
@@ -965,6 +986,7 @@ export const layer = <E = never, R = never>(
  * @see {@link layer} – replace the provider entirely
  * @see {@link orElse} – compose providers without layers
  *
+ * @stability stable
  * @category layers
  * @since 4.0.0
  */
@@ -1032,6 +1054,7 @@ export const layerAdd = <E = never, R = never>(
  * @see {@link fromEnv} – for environment variables
  * @see {@link make} – for custom backing stores
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1116,6 +1139,7 @@ function emptyStringAsMissing(value: string | undefined, preserveEmptyStrings: b
  *
  * @see {@link fromEnv} – automatically reads the runtime environment
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1178,6 +1202,7 @@ export function fromEnvRecord(
  * @see {@link fromEnvRecord} – for explicit records in restricted runtimes
  * @see {@link constantCase} – bridge camelCase keys to SCREAMING_SNAKE_CASE
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -1297,6 +1322,7 @@ function trieNodeAt(root: EnvTrieNode, path: Path): EnvTrieNode | undefined {
  * @see {@link fromEnvRecord} – for explicit environment records
  * @see {@link fromEnv} – for raw environment variable access
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1452,6 +1478,7 @@ function searchLast(str: string, rgx: RegExp): number {
  * @see {@link fromDotEnvContents} – parse a `.env` string directly
  * @see {@link fromEnv} – read from the runtime environment
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */
@@ -1523,6 +1550,7 @@ export const fromDotEnv: (options?: {
  * @see {@link fromEnv} – for environment variables
  * @see {@link fromDotEnv} – for `.env` files
  *
+ * @stability unstable
  * @category constructors
  * @since 4.0.0
  */

package/src/Console.ts

@@ -7,6 +7,7 @@
  * tests or other environments. This module also includes scoped helpers that
  * close console groups or timers automatically.
  *
+ * @stability stable
  * @since 2.0.0
  */
 import type * as Context from "./Context.ts"
@@ -19,6 +20,7 @@ import type { Scope } from "./Scope.ts"
 /**
  * Represents a console interface for logging, debugging, timing, and grouping output.
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -77,6 +79,7 @@ export interface Console {
  *
  * @see {@link consoleWith} for using the current console service inside an effect
  *
+ * @stability stable
  * @category services
  * @since 2.0.0
  */
@@ -106,6 +109,7 @@ export const Console: Context.Reference<Console> = effect.ConsoleRef
  * messages // => ["Hello, world!", "This is an error message"]
  * ```
  *
+ * @stability stable
  * @category constructors
  * @since 2.0.0
  */
@@ -135,6 +139,7 @@ export const consoleWith = <A, E, R>(f: (console: Console) => Effect.Effect<A, E
  * errors // => ["This will be logged as an error"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -178,6 +183,7 @@ export const assert = (condition: boolean, ...args: ReadonlyArray<any>): Effect.
  * operations // => ["log:This will be cleared", "clear", "log:This appears after clearing"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -214,6 +220,7 @@ export const clear: Effect.Effect<void> = consoleWith((console) =>
  * messages // => ["my-counter: 1", "my-counter: 2", "default: 1"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -253,6 +260,7 @@ export const count = (label?: string): Effect.Effect<void> =>
  * messages // => ["my-counter: 1", "my-counter: 2", "my-counter: 1"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -290,6 +298,7 @@ export const countReset = (label?: string): Effect.Effect<void> =>
  * messages // => [["Debug info:", { userId: 123, action: "login" }], ["Processing step", 1, "of", 5]]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -326,6 +335,7 @@ export const debug = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * inspected // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -356,6 +366,7 @@ export const dir = (item: any, options?: any): Effect.Effect<void> =>
  * messages // => ["<user id=\"1\">Ada</user>"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -395,6 +406,7 @@ export const dirxml = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * messages // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -441,6 +453,7 @@ export const error = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * operations // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -492,6 +505,7 @@ export const group = (
  * messages // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -529,6 +543,7 @@ export const info = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * messages // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -568,6 +583,7 @@ export const log = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * calls // => [{ rows: 3, properties: undefined }, { rows: 3, properties: ["name", "age"] }]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -607,6 +623,7 @@ export const table = (tabularData: any, properties?: ReadonlyArray<string>): Eff
  * operations // => ["start:operation-timer", "log:Operation completed", "end:operation-timer"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -652,6 +669,7 @@ export const time = (label?: string | undefined): Effect.Effect<void, never, Sco
  * operations // => [["start", "long-operation"], ["log", "long-operation", "Halfway done"], ["end", "long-operation"]]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -685,6 +703,7 @@ export const timeLog = (label?: string, ...args: ReadonlyArray<any>): Effect.Eff
  * traces // => [["Debug trace point"], ["Function call:", { functionName: "processData" }]]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -723,6 +742,7 @@ export const trace = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * messages // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -769,6 +789,7 @@ export const warn = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
  * operations // => expected
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -809,6 +830,7 @@ export const withGroup = dual<
    * operations // => expected
    * ```
    *
+   * @stability stable
    * @category accessors
    * @since 2.0.0
    */
@@ -854,6 +876,7 @@ export const withGroup = dual<
    * operations // => expected
    * ```
    *
+   * @stability stable
    * @category accessors
    * @since 2.0.0
    */
@@ -910,6 +933,7 @@ export const withGroup = dual<
  * operations // => ["start:my-operation", "log:Operation completed", "end:my-operation"]
  * ```
  *
+ * @stability stable
  * @category accessors
  * @since 2.0.0
  */
@@ -942,6 +966,7 @@ export const withTime = dual<
    * operations // => ["start:my-operation", "log:Operation completed", "end:my-operation"]
    * ```
    *
+   * @stability stable
    * @category accessors
    * @since 2.0.0
    */
@@ -974,6 +999,7 @@ export const withTime = dual<
    * operations // => ["start:my-operation", "log:Operation completed", "end:my-operation"]
    * ```
    *
+   * @stability stable
    * @category accessors
    * @since 2.0.0
    */