effect 4.0.0-beta.71 → 4.0.0-beta.72

package/src/Console.ts

@@ -109,7 +109,7 @@ export interface Console {
 }
 
 /**
- * A reference to the current console service in the Effect system, allowing access to the active console implementation from within the Effect context.
+ * Context reference for the current console service in the Effect system, allowing access to the active console implementation from within the Effect context.
  *
  * **When to use**
  *
@@ -186,7 +186,7 @@ export const assert = (condition: boolean, ...args: ReadonlyArray<any>): Effect.
   )
 
 /**
- * Invokes the current console service's clear operation.
+ * Runs the current console service's clear operation.
  *
  * **When to use**
  *
@@ -352,7 +352,8 @@ export const dirxml = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
   )
 
 /**
- * Outputs an error-level message to the console, typically displayed with error styling by the active console implementation.
+ * Writes an error-level message to the console, typically displayed with error
+ * styling by the active console implementation.
  *
  * **Example** (Writing error messages)
  *
@@ -421,7 +422,8 @@ export const group = (
   )
 
 /**
- * Outputs an informational message to the console, typically displayed with info styling by the active console implementation.
+ * Writes an informational message to the console, typically displayed with info
+ * styling by the active console implementation.
  *
  * **Example** (Writing informational messages)
  *
@@ -448,7 +450,7 @@ export const info = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
   )
 
 /**
- * Outputs a general-purpose message to the console for ordinary logging.
+ * Logs a general-purpose message to the console.
  *
  * **Example** (Writing log messages)
  *
@@ -569,7 +571,8 @@ export const timeLog = (label?: string, ...args: ReadonlyArray<any>): Effect.Eff
   )
 
 /**
- * Outputs the current stack trace to the console to show how the current point in the code was reached.
+ * Writes the current stack trace to the console to show how the current point in
+ * the code was reached.
  *
  * **Example** (Writing stack traces)
  *
@@ -593,7 +596,8 @@ export const trace = (...args: ReadonlyArray<any>): Effect.Effect<void> =>
   )
 
 /**
- * Outputs a warning-level message to the console, typically displayed with warning styling by the active console implementation.
+ * Writes a warning-level message to the console, typically displayed with
+ * warning styling by the active console implementation.
  *
  * **Example** (Writing warning messages)
  *

package/src/Context.ts

@@ -193,8 +193,8 @@ export declare namespace ServiceClass {
  *
  * **When to use**
  *
- * Use when you use `Service` for dependencies that must be provided by the surrounding
- * context. Use `Reference` when a dependency should have a default value.
+ * Use when a dependency must be provided by the surrounding context. Use
+ * `Reference` when a dependency should have a default value.
  *
  * **Details**
  *
@@ -242,8 +242,8 @@ export const Service: {
    *
    * **When to use**
    *
-   * Use when you use `Service` for dependencies that must be provided by the surrounding
-   * context. Use `Reference` when a dependency should have a default value.
+   * Use when a dependency must be provided by the surrounding context. Use
+   * `Reference` when a dependency should have a default value.
    *
    * **Details**
    *
@@ -291,8 +291,8 @@ export const Service: {
    *
    * **When to use**
    *
-   * Use when you use `Service` for dependencies that must be provided by the surrounding
-   * context. Use `Reference` when a dependency should have a default value.
+   * Use when a dependency must be provided by the surrounding context. Use
+   * `Reference` when a dependency should have a default value.
    *
    * **Details**
    *
@@ -353,8 +353,8 @@ export const Service: {
    *
    * **When to use**
    *
-   * Use when you use `Service` for dependencies that must be provided by the surrounding
-   * context. Use `Reference` when a dependency should have a default value.
+   * Use when a dependency must be provided by the surrounding context. Use
+   * `Reference` when a dependency should have a default value.
    *
    * **Details**
    *
@@ -710,7 +710,7 @@ const Proto: Omit<Context<never>, "mapUnsafe" | "mutable"> = {
 }
 
 /**
- * Checks if the provided argument is a `Context`.
+ * Checks whether the provided argument is a `Context`.
  *
  * **When to use**
  *
@@ -745,7 +745,7 @@ const Proto: Omit<Context<never>, "mapUnsafe" | "mutable"> = {
 export const isContext = (u: unknown): u is Context<never> => hasProperty(u, TypeId)
 
 /**
- * Checks if the provided argument is a `Key`.
+ * Checks whether the provided argument is a `Key`.
  *
  * **Example** (Checking for keys)
  *
@@ -762,7 +762,7 @@ export const isContext = (u: unknown): u is Context<never> => hasProperty(u, Typ
 export const isKey = (u: unknown): u is Key<any, any> => hasProperty(u, ServiceTypeId)
 
 /**
- * Checks if the provided argument is a `Reference`.
+ * Checks whether the provided argument is a `Reference`.
  *
  * **Example** (Checking for references)
  *
@@ -1236,8 +1236,8 @@ export const getOrElse: {
  *
  * **When to use**
  *
- * Use when you use `getOrUndefined` for raw map-style lookup. Use `getOption` when you want
- * the usual `Context.Reference` default-value behavior.
+ * Use when you need raw map-style lookup. Use `getOption` when you want the
+ * usual `Context.Reference` default-value behavior.
  *
  * **Gotchas**
  *
@@ -1256,8 +1256,8 @@ export const getOrUndefined: {
    *
    * **When to use**
    *
-   * Use when you use `getOrUndefined` for raw map-style lookup. Use `getOption` when you want
-   * the usual `Context.Reference` default-value behavior.
+   * Use when you need raw map-style lookup. Use `getOption` when you want the
+   * usual `Context.Reference` default-value behavior.
    *
    * **Gotchas**
    *
@@ -1276,8 +1276,8 @@ export const getOrUndefined: {
    *
    * **When to use**
    *
-   * Use when you use `getOrUndefined` for raw map-style lookup. Use `getOption` when you want
-   * the usual `Context.Reference` default-value behavior.
+   * Use when you need raw map-style lookup. Use `getOption` when you want the
+   * usual `Context.Reference` default-value behavior.
    *
    * **Gotchas**
    *
@@ -1301,9 +1301,9 @@ export const getOrUndefined: {
  *
  * **When to use**
  *
- * Use when you use `getUnsafe` only when the context type cannot prove that the service is
- * present. Use `get` when the service requirement is tracked in the context
- * type, or `getOption` when absence is expected.
+ * Use when the context type cannot prove that the service is present. Use
+ * `get` when the service requirement is tracked in the context type, or
+ * `getOption` when absence is expected.
  *
  * **Details**
  *
@@ -1339,9 +1339,9 @@ export const getUnsafe: {
    *
    * **When to use**
    *
-   * Use when you use `getUnsafe` only when the context type cannot prove that the service is
-   * present. Use `get` when the service requirement is tracked in the context
-   * type, or `getOption` when absence is expected.
+   * Use when the context type cannot prove that the service is present. Use
+   * `get` when the service requirement is tracked in the context type, or
+   * `getOption` when absence is expected.
    *
    * **Details**
    *
@@ -1377,9 +1377,9 @@ export const getUnsafe: {
    *
    * **When to use**
    *
-   * Use when you use `getUnsafe` only when the context type cannot prove that the service is
-   * present. Use `get` when the service requirement is tracked in the context
-   * type, or `getOption` when absence is expected.
+   * Use when the context type cannot prove that the service is present. Use
+   * `get` when the service requirement is tracked in the context type, or
+   * `getOption` when absence is expected.
    *
    * **Details**
    *
@@ -1421,7 +1421,7 @@ export const getUnsafe: {
 )
 
 /**
- * Get a service from the context that corresponds to the given key.
+ * Gets a service from the context that corresponds to the given key.
  *
  * **When to use**
  *
@@ -1453,7 +1453,7 @@ export const getUnsafe: {
  */
 export const get: {
   /**
-   * Get a service from the context that corresponds to the given key.
+   * Gets a service from the context that corresponds to the given key.
    *
    * **When to use**
    *
@@ -1485,7 +1485,7 @@ export const get: {
    */
   <Services, I extends Services, S>(service: Key<I, S>): (self: Context<Services>) => S
   /**
-   * Get a service from the context that corresponds to the given key.
+   * Gets a service from the context that corresponds to the given key.
    *
    * **When to use**
    *
@@ -1597,7 +1597,7 @@ const serviceNotFoundError = (service: Key<any, any>) => {
 }
 
 /**
- * Gets the service for a key wrapped in an `Option`.
+ * Gets the service for a key safely wrapped in an `Option`.
  *
  * **When to use**
  *
@@ -1635,7 +1635,7 @@ const serviceNotFoundError = (service: Key<any, any>) => {
  */
 export const getOption: {
   /**
-   * Gets the service for a key wrapped in an `Option`.
+   * Gets the service for a key safely wrapped in an `Option`.
    *
    * **When to use**
    *
@@ -1673,7 +1673,7 @@ export const getOption: {
    */
   <S, I>(service: Key<I, S>): <Services>(self: Context<Services>) => Option.Option<S>
   /**
-   * Gets the service for a key wrapped in an `Option`.
+   * Gets the service for a key safely wrapped in an `Option`.
    *
    * **When to use**
    *
@@ -1986,7 +1986,7 @@ export const omit = <S extends ReadonlyArray<Key<any, any>>>(
   })
 
 /**
- * Perform a series of mutations on a `Context`. Prevents unnecessary copying
+ * Performs a series of mutations on a `Context`. Prevents unnecessary copying
  * of the underlying map when multiple mutations are needed.
  *
  * **When to use**
@@ -2005,7 +2005,7 @@ export const omit = <S extends ReadonlyArray<Key<any, any>>>(
  */
 export const mutate: {
   /**
-   * Perform a series of mutations on a `Context`. Prevents unnecessary copying
+   * Performs a series of mutations on a `Context`. Prevents unnecessary copying
    * of the underlying map when multiple mutations are needed.
    *
    * **When to use**
@@ -2024,7 +2024,7 @@ export const mutate: {
    */
   <Services, B>(f: (context: Context<Services>) => Context<B>): <Services>(self: Context<Services>) => Context<B>
   /**
-   * Perform a series of mutations on a `Context`. Prevents unnecessary copying
+   * Performs a series of mutations on a `Context`. Prevents unnecessary copying
    * of the underlying map when multiple mutations are needed.
    *
    * **When to use**
@@ -2046,7 +2046,7 @@ export const mutate: {
   2,
   <Services, B>(self: Context<Services>, f: (context: Context<Services>) => Context<B>): Context<B> => {
     const next = makeUnsafe</**
-     * Perform a series of mutations on a `Context`. Prevents unnecessary copying
+     * Performs a series of mutations on a `Context`. Prevents unnecessary copying
      * of the underlying map when multiple mutations are needed.
      *
      * **When to use**

package/src/Cron.ts

@@ -239,7 +239,7 @@ const CronProto = {
 }
 
 /**
- * Checks if a given value is a Cron instance.
+ * Checks whether a given value is a Cron instance.
  *
  * **When to use**
  *
@@ -521,7 +521,7 @@ export class CronParseError extends Data.TaggedError("CronParseError")<{
 }
 
 /**
- * Checks if a given value is a CronParseError instance.
+ * Checks whether a given value is a CronParseError instance.
  *
  * **When to use**
  *
@@ -557,8 +557,8 @@ export class CronParseError extends Data.TaggedError("CronParseError")<{
 export const isCronParseError = (u: unknown): u is CronParseError => hasProperty(u, CronParseErrorTypeId)
 
 /**
- * Parses a cron expression into a `Cron` instance, returning a `Result` instead
- * of throwing.
+ * Parses a cron expression safely into a `Cron` instance, returning a `Result`
+ * instead of throwing.
  *
  * **When to use**
  *
@@ -993,12 +993,13 @@ export const sequence = function*(cron: Cron, now?: DateTime.DateTime.Input): It
 }
 
 /**
- * An `Equivalence` instance for comparing the field restrictions of two `Cron`
+ * Equivalence instance for comparing the field restrictions of two `Cron`
  * schedules.
  *
  * **When to use**
  *
- * Use to compare cron schedules through APIs that accept an `Equivalence`.
+ * Use to compare cron schedules through APIs that accept an equivalence
+ * relation.
  *
  * **Details**
  *

package/src/Crypto.ts

@@ -198,7 +198,7 @@ export interface Crypto {
 }
 
 /**
- * The service identifier for the platform `Crypto` service.
+ * Service tag for platform cryptography.
  *
  * **When to use**
  *

package/src/Data.ts

@@ -83,7 +83,7 @@ import type * as Types from "./Types.ts"
 import type { Unify } from "./Unify.ts"
 
 /**
- * Base class for immutable data types.
+ * Provides a base class for immutable data types.
  *
  * **When to use**
  *
@@ -127,7 +127,7 @@ export const Class: new<A extends Record<string, any> = {}>(
 } as any
 
 /**
- * Base class for immutable data types with a `_tag` discriminator.
+ * Provides a base class for immutable data types with a `_tag` discriminator.
  *
  * **When to use**
  *
@@ -179,8 +179,7 @@ export const TaggedClass = <Tag extends string>(
  * **Details**
  *
  * Each key in the record becomes a variant with `readonly _tag` set to that
- * key. Use with {@link taggedEnum} to get runtime constructors, type guards,
- * and pattern matching.
+ * key. Use with {@link taggedEnum} to get constructors and matchers.
  *
  * **Gotchas**
  *
@@ -207,7 +206,7 @@ export const TaggedClass = <Tag extends string>(
  * // "BadRequest"
  * ```
  *
- * @see {@link taggedEnum} — runtime constructors for a `TaggedEnum`
+ * @see {@link taggedEnum} — constructors and matchers for a `TaggedEnum`
  * @see {@link TaggedEnum.WithGenerics} — generic tagged enums
  * @see {@link TaggedEnum.Constructor} — the constructor object type
  *
@@ -255,7 +254,7 @@ export declare namespace TaggedEnum {
    *
    * **When to use**
    *
-   * Use when variant payloads need to be parameterized, such as `Result<E, A>`. Pass the interface, not the type alias, to {@link taggedEnum} to get generic-aware constructors.
+   * Use when variant payloads need to be parameterized, such as `Result<E, A>`. Pass the interface, not the type alias, to {@link taggedEnum} to get generic-aware constructors and matchers.
    *
    * **Details**
    *
@@ -284,7 +283,7 @@ export declare namespace TaggedEnum {
    * ```
    *
    * @see {@link Kind} — apply concrete types to a `WithGenerics` definition
-   * @see {@link taggedEnum} — runtime constructors
+   * @see {@link taggedEnum} — constructors and matchers
    *
    * @category models
    * @since 2.0.0
@@ -417,12 +416,11 @@ export declare namespace TaggedEnum {
   > = Extract<A, { readonly _tag: K }>
 
   /**
-   * The full constructor-object type returned by {@link taggedEnum}.
+   * The full constructors-and-matchers object type returned by {@link taggedEnum}.
    *
    * **When to use**
    *
-   * Use to type the full constructor and matcher object returned by
-   * `taggedEnum`.
+   * Use to type the constructors-and-matchers object returned by `taggedEnum`.
    *
    * **Details**
    *
@@ -458,7 +456,7 @@ export declare namespace TaggedEnum {
    * })
    * ```
    *
-   * @see {@link taggedEnum} — creates a `Constructor`
+   * @see {@link taggedEnum} — creates constructors and matchers
    *
    * @category types
    * @since 3.1.0
@@ -584,12 +582,11 @@ export declare namespace TaggedEnum {
 }
 
 /**
- * Creates runtime constructors, type guards, and pattern matching for a
- * {@link TaggedEnum} type.
+ * Creates constructors and matchers for a `TaggedEnum` type.
  *
  * **When to use**
  *
- * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+ * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
  *
  * **Details**
  *
@@ -657,12 +654,11 @@ export declare namespace TaggedEnum {
  */
 export const taggedEnum: {
   /**
-   * Creates runtime constructors, type guards, and pattern matching for a
-   * {@link TaggedEnum} type.
+   * Creates constructors and matchers for a `TaggedEnum` type.
    *
    * **When to use**
    *
-   * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+   * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
    *
    * **Details**
    *
@@ -741,12 +737,11 @@ export const taggedEnum: {
   >
 
   /**
-   * Creates runtime constructors, type guards, and pattern matching for a
-   * {@link TaggedEnum} type.
+   * Creates constructors and matchers for a `TaggedEnum` type.
    *
    * **When to use**
    *
-   * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+   * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
    *
    * **Details**
    *
@@ -825,12 +820,11 @@ export const taggedEnum: {
   >
 
   /**
-   * Creates runtime constructors, type guards, and pattern matching for a
-   * {@link TaggedEnum} type.
+   * Creates constructors and matchers for a `TaggedEnum` type.
    *
    * **When to use**
    *
-   * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+   * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
    *
    * **Details**
    *
@@ -909,12 +903,11 @@ export const taggedEnum: {
   >
 
   /**
-   * Creates runtime constructors, type guards, and pattern matching for a
-   * {@link TaggedEnum} type.
+   * Creates constructors and matchers for a `TaggedEnum` type.
    *
    * **When to use**
    *
-   * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+   * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
    *
    * **Details**
    *
@@ -993,12 +986,11 @@ export const taggedEnum: {
   >
 
   /**
-   * Creates runtime constructors, type guards, and pattern matching for a
-   * {@link TaggedEnum} type.
+   * Creates constructors and matchers for a `TaggedEnum` type.
    *
    * **When to use**
    *
-   * Use when you have a `TaggedEnum` type and need to construct or inspect values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
+   * Use when you have a `TaggedEnum` type and need constructors and matchers for its values. For generic enums, pass a {@link TaggedEnum.WithGenerics} interface.
    *
    * **Details**
    *
@@ -1110,11 +1102,12 @@ function taggedMatch<
 }
 
 /**
- * Base class for yieldable errors.
+ * Provides a base class for yieldable errors.
  *
  * **When to use**
  *
- * Use when you use `Error` for errors that do **not** need tag-based discrimination. If you need `Effect.catchTag` support, use {@link TaggedError}.
+ * Use when defining yieldable errors that do **not** need tag-based
+ * discrimination. If you need tag-based recovery, use {@link TaggedError}.
  *
  * **Details**
  *
@@ -1156,7 +1149,8 @@ export const Error: new<A extends Record<string, any> = {}>(
  *
  * **When to use**
  *
- * Use when you use `TaggedError` for domain errors in Effect applications where you want discriminated-union error handling.
+ * Use when modeling domain errors in Effect applications where you want
+ * discriminated-union error handling.
  *
  * **Details**
  *