effect 4.0.0-beta.71 → 4.0.0-beta.73

package/src/Record.ts

@@ -237,7 +237,7 @@ export const empty = <K extends string | symbol = never, V = never>(): Record<
 > => ({} as any)
 
 /**
- * Determine if a record is empty.
+ * Determines if a mutable record is empty.
  *
  * **Example** (Checking for an empty record)
  *
@@ -256,7 +256,7 @@ export const isEmptyRecord = <K extends string, A>(self: Record<K, A>): self is
   Object.keys(self).length === 0
 
 /**
- * Determine if a record is empty.
+ * Determines if a readonly record is empty.
  *
  * **Example** (Checking for an empty readonly record)
  *
@@ -523,7 +523,7 @@ export const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>) => Arr
 export const size = <K extends string, A>(self: ReadonlyRecord<K, A>): number => keys(self).length
 
 /**
- * Check if a given `key` exists in a record.
+ * Checks whether a given `key` exists in a record.
  *
  * **Example** (Checking key membership)
  *
@@ -540,7 +540,7 @@ export const size = <K extends string, A>(self: ReadonlyRecord<K, A>): number =>
  */
 export const has: {
   /**
-   * Check if a given `key` exists in a record.
+   * Checks whether a given `key` exists in a record.
    *
    * **Example** (Checking key membership)
    *
@@ -557,7 +557,7 @@ export const has: {
    */
   <K extends string | symbol>(key: NoInfer<K>): <A>(self: ReadonlyRecord<K, A>) => boolean
   /**
-   * Check if a given `key` exists in a record.
+   * Checks whether a given `key` exists in a record.
    *
    * **Example** (Checking key membership)
    *
@@ -582,7 +582,7 @@ export const has: {
 )
 
 /**
- * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
+ * Retrieves a value at a particular key from a record safely, returning it wrapped in an `Option`.
  *
  * **Example** (Getting a value as an Option)
  *
@@ -601,7 +601,7 @@ export const has: {
  */
 export const get: {
   /**
-   * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
+   * Retrieves a value at a particular key from a record safely, returning it wrapped in an `Option`.
    *
    * **Example** (Getting a value as an Option)
    *
@@ -620,7 +620,7 @@ export const get: {
    */
   <K extends string | symbol>(key: NoInfer<K>): <A>(self: ReadonlyRecord<K, A>) => Option.Option<A>
   /**
-   * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
+   * Retrieves a value at a particular key from a record safely, returning it wrapped in an `Option`.
    *
    * **Example** (Getting a value as an Option)
    *
@@ -645,7 +645,7 @@ export const get: {
 )
 
 /**
- * Apply a function to the element at the specified key, creating a new record,
+ * Applies a function to the element at the specified key safely, creating a new record,
  * or return `Option.none()` if the key doesn't exist.
  *
  * **Example** (Modifying a value at a key)
@@ -666,7 +666,7 @@ export const get: {
  */
 export const modify: {
   /**
-   * Apply a function to the element at the specified key, creating a new record,
+   * Applies a function to the element at the specified key safely, creating a new record,
    * or return `Option.none()` if the key doesn't exist.
    *
    * **Example** (Modifying a value at a key)
@@ -687,7 +687,7 @@ export const modify: {
    */
   <K extends string | symbol, A, B>(key: NoInfer<K>, f: (a: A) => B): (self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
   /**
-   * Apply a function to the element at the specified key, creating a new record,
+   * Applies a function to the element at the specified key safely, creating a new record,
    * or return `Option.none()` if the key doesn't exist.
    *
    * **Example** (Modifying a value at a key)
@@ -720,7 +720,7 @@ export const modify: {
 )
 
 /**
- * Replaces the value at an existing key and returns the updated record in
+ * Replaces the value at an existing key safely and returns the updated record in
  * `Option.some`.
  *
  * **Details**
@@ -742,7 +742,7 @@ export const modify: {
  */
 export const replace: {
   /**
-   * Replaces the value at an existing key and returns the updated record in
+   * Replaces the value at an existing key safely and returns the updated record in
    * `Option.some`.
    *
    * **Details**
@@ -764,7 +764,7 @@ export const replace: {
    */
   <K extends string | symbol, B>(key: NoInfer<K>, b: B): <A>(self: ReadonlyRecord<K, A>) => Option.Option<Record<K, A | B>>
   /**
-   * Replaces the value at an existing key and returns the updated record in
+   * Replaces the value at an existing key safely and returns the updated record in
    * `Option.some`.
    *
    * **Details**
@@ -795,8 +795,16 @@ export const replace: {
 )
 
 /**
- * If the given key exists in the record, returns a new record with the key removed.
- * If the key does not exist, returns a shallow copy of the original record.
+ * Removes a key from a record.
+ *
+ * **When to use**
+ *
+ * Use to create a shallow copy of a record without one property.
+ *
+ * **Details**
+ *
+ * If the key is not present, the result is still a shallow copy of the original
+ * record.
  *
  * **Example** (Removing a key)
  *
@@ -812,8 +820,16 @@ export const replace: {
  */
 export const remove: {
   /**
-   * If the given key exists in the record, returns a new record with the key removed.
-   * If the key does not exist, returns a shallow copy of the original record.
+   * Removes a key from a record.
+   *
+   * **When to use**
+   *
+   * Use to create a shallow copy of a record without one property.
+   *
+   * **Details**
+   *
+   * If the key is not present, the result is still a shallow copy of the original
+   * record.
    *
    * **Example** (Removing a key)
    *
@@ -829,8 +845,16 @@ export const remove: {
    */
   <K extends string | symbol, X extends K>(key: X): <A>(self: ReadonlyRecord<K, A>) => Record<Exclude<K, X>, A>
   /**
-   * If the given key exists in the record, returns a new record with the key removed.
-   * If the key does not exist, returns a shallow copy of the original record.
+   * Removes a key from a record.
+   *
+   * **When to use**
+   *
+   * Use to create a shallow copy of a record without one property.
+   *
+   * **Details**
+   *
+   * If the key is not present, the result is still a shallow copy of the original
+   * record.
    *
    * **Example** (Removing a key)
    *
@@ -858,7 +882,7 @@ export const remove: {
 )
 
 /**
- * Retrieves the value of the property with the given `key` from a record and returns an `Option`
+ * Retrieves the value of the property with the given `key` from a record safely and returns an `Option`
  * of a tuple with the value and the record with the removed property.
  * If the key is not present, returns `Option.none()`.
  *
@@ -878,7 +902,7 @@ export const remove: {
  */
 export const pop: {
   /**
-   * Retrieves the value of the property with the given `key` from a record and returns an `Option`
+   * Retrieves the value of the property with the given `key` from a record safely and returns an `Option`
    * of a tuple with the value and the record with the removed property.
    * If the key is not present, returns `Option.none()`.
    *
@@ -898,7 +922,7 @@ export const pop: {
    */
   <K extends string | symbol, X extends K>(key: X): <A>(self: ReadonlyRecord<K, A>) => Option.Option<[A, Record<Exclude<K, X>, A>]>
   /**
-   * Retrieves the value of the property with the given `key` from a record and returns an `Option`
+   * Retrieves the value of the property with the given `key` from a record safely and returns an `Option`
    * of a tuple with the value and the record with the removed property.
    * If the key is not present, returns `Option.none()`.
    *
@@ -1320,7 +1344,8 @@ export const filter: {
 )
 
 /**
- * Given a record with `Option` values, returns a new record containing only the `Some` values, preserving the original keys.
+ * Returns a new record containing only the `Some` values from a record of
+ * `Option` values, preserving the original keys.
  *
  * **Example** (Extracting Some values)
  *
@@ -1353,7 +1378,8 @@ export const getSomes: <K extends string, A>(
 }
 
 /**
- * Given a record with `Result` values, returns a new record containing only the `Err` values, preserving the original keys.
+ * Returns a new record containing only the `Err` values from a record of
+ * `Result` values, preserving the original keys.
  *
  * **Example** (Extracting Result failures)
  *
@@ -1389,7 +1415,8 @@ export const getFailures = <K extends string, A, E>(
 }
 
 /**
- * Given a record with `Result` values, returns a new record containing only the `Ok` values, preserving the original keys.
+ * Returns a new record containing only the `Ok` values from a record of
+ * `Result` values, preserving the original keys.
  *
  * **Example** (Extracting Result successes)
  *
@@ -1542,7 +1569,7 @@ export const separate: <K extends string, A, B>(
 ) => [Record<ReadonlyRecord.NonLiteralKey<K>, A>, Record<ReadonlyRecord.NonLiteralKey<K>, B>] = partition(identity)
 
 /**
- * Retrieve the keys of a given record as an array.
+ * Retrieves the keys of a given record as an array.
  *
  * **Example** (Getting record keys)
  *
@@ -1560,7 +1587,7 @@ export const keys = <K extends string | symbol, A>(self: ReadonlyRecord<K, A>):
   Object.keys(self) as Array<K & string>
 
 /**
- * Retrieve the values of a given record as an array.
+ * Retrieves the values of a given record as an array.
  *
  * **Example** (Getting record values)
  *
@@ -1577,7 +1604,7 @@ export const keys = <K extends string | symbol, A>(self: ReadonlyRecord<K, A>):
 export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A> => collect(self, (_, a) => a)
 
 /**
- * Add a new key-value pair or update an existing key's value in a record.
+ * Adds a new key-value pair or update an existing key's value in a record.
  *
  * **Example** (Setting a record value)
  *
@@ -1594,7 +1621,7 @@ export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A
  */
 export const set: {
   /**
-   * Add a new key-value pair or update an existing key's value in a record.
+   * Adds a new key-value pair or update an existing key's value in a record.
    *
    * **Example** (Setting a record value)
    *
@@ -1611,7 +1638,7 @@ export const set: {
    */
   <K extends string | symbol, K1 extends K | ((string | symbol) & {}), B>(key: K1, value: B): <A>(self: ReadonlyRecord<K, A>) => Record<K | K1, A | B>
   /**
-   * Add a new key-value pair or update an existing key's value in a record.
+   * Adds a new key-value pair or update an existing key's value in a record.
    *
    * **Example** (Setting a record value)
    *
@@ -1639,7 +1666,7 @@ export const set: {
 )
 
 /**
- * Check if all the keys and values in one record are also found in another record.
+ * Checks whether all the keys and values in one record are also found in another record.
  * Uses the provided equivalence function to compare values.
  *
  * **Example** (Checking subrecords with a custom equivalence)
@@ -1771,7 +1798,7 @@ export const isSubrecord: {
 } = isSubrecordBy(Equal.asEquivalence())
 
 /**
- * Reduce a record to a single value by combining its entries with a specified function.
+ * Reduces a record to a single value by combining its entries with a specified function.
  *
  * **Example** (Reducing record values)
  *
@@ -1790,7 +1817,7 @@ export const isSubrecord: {
  */
 export const reduce: {
   /**
-   * Reduce a record to a single value by combining its entries with a specified function.
+   * Reduces a record to a single value by combining its entries with a specified function.
    *
    * **Example** (Reducing record values)
    *
@@ -1809,7 +1836,7 @@ export const reduce: {
    */
   <Z, V, K extends string>(zero: Z, f: (accumulator: Z, value: V, key: K) => Z): (self: ReadonlyRecord<K, V>) => Z
   /**
-   * Reduce a record to a single value by combining its entries with a specified function.
+   * Reduces a record to a single value by combining its entries with a specified function.
    *
    * **Example** (Reducing record values)
    *
@@ -1847,7 +1874,7 @@ export const reduce: {
 )
 
 /**
- * Check if all entries in a record meet a specific condition.
+ * Checks whether all entries in a record meet a specific condition.
  *
  * **Example** (Checking every record value)
  *
@@ -1864,7 +1891,7 @@ export const reduce: {
  */
 export const every: {
   /**
-   * Check if all entries in a record meet a specific condition.
+   * Checks whether all entries in a record meet a specific condition.
    *
    * **Example** (Checking every record value)
    *
@@ -1881,7 +1908,7 @@ export const every: {
    */
   <A, K extends string, B extends A>(refinement: (value: A, key: K) => value is B): (self: ReadonlyRecord<K, A>) => self is ReadonlyRecord<K, B>
   /**
-   * Check if all entries in a record meet a specific condition.
+   * Checks whether all entries in a record meet a specific condition.
    *
    * **Example** (Checking every record value)
    *
@@ -1898,7 +1925,7 @@ export const every: {
    */
   <A, K extends string>(predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord<K, A>) => boolean
   /**
-   * Check if all entries in a record meet a specific condition.
+   * Checks whether all entries in a record meet a specific condition.
    *
    * **Example** (Checking every record value)
    *
@@ -1915,7 +1942,7 @@ export const every: {
    */
   <A, K extends string, B extends A>(self: ReadonlyRecord<K, A>, refinement: (value: A, key: K) => value is B): self is ReadonlyRecord<K, B>
   /**
-   * Check if all entries in a record meet a specific condition.
+   * Checks whether all entries in a record meet a specific condition.
    *
    * **Example** (Checking every record value)
    *
@@ -1947,7 +1974,7 @@ export const every: {
 )
 
 /**
- * Check if any entry in a record meets a specific condition.
+ * Checks whether any entry in a record meets a specific condition.
  *
  * **Example** (Checking for any matching value)
  *
@@ -1964,7 +1991,7 @@ export const every: {
  */
 export const some: {
   /**
-   * Check if any entry in a record meets a specific condition.
+   * Checks whether any entry in a record meets a specific condition.
    *
    * **Example** (Checking for any matching value)
    *
@@ -1981,7 +2008,7 @@ export const some: {
    */
   <A, K extends string>(predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord<K, A>) => boolean
   /**
-   * Check if any entry in a record meets a specific condition.
+   * Checks whether any entry in a record meets a specific condition.
    *
    * **Example** (Checking for any matching value)
    *
@@ -2010,7 +2037,7 @@ export const some: {
 )
 
 /**
- * Merge two records, preserving entries that exist in either of the records.
+ * Merges two records, preserving entries that exist in either of the records.
  * For keys that exist in both records, the provided combine function is used to merge the values.
  *
  * **Example** (Merging records with union)
@@ -2030,7 +2057,7 @@ export const some: {
  */
 export const union: {
   /**
-   * Merge two records, preserving entries that exist in either of the records.
+   * Merges two records, preserving entries that exist in either of the records.
    * For keys that exist in both records, the provided combine function is used to merge the values.
    *
    * **Example** (Merging records with union)
@@ -2050,7 +2077,7 @@ export const union: {
    */
   <K1 extends string, A, B, C>(that: ReadonlyRecord<K1, B>, combine: (selfValue: A, thatValue: B) => C): <K0 extends string>(self: ReadonlyRecord<K0, A>) => Record<K0 | K1, A | B | C>
   /**
-   * Merge two records, preserving entries that exist in either of the records.
+   * Merges two records, preserving entries that exist in either of the records.
    * For keys that exist in both records, the provided combine function is used to merge the values.
    *
    * **Example** (Merging records with union)
@@ -2104,7 +2131,7 @@ export const union: {
 )
 
 /**
- * Merge two records, retaining only the entries that exist in both records.
+ * Merges two records, retaining only the entries that exist in both records.
  * For intersecting keys, the provided combine function is used to merge the values.
  *
  * **Example** (Merging intersecting keys)
@@ -2124,7 +2151,7 @@ export const union: {
  */
 export const intersection: {
   /**
-   * Merge two records, retaining only the entries that exist in both records.
+   * Merges two records, retaining only the entries that exist in both records.
    * For intersecting keys, the provided combine function is used to merge the values.
    *
    * **Example** (Merging intersecting keys)
@@ -2144,7 +2171,7 @@ export const intersection: {
    */
   <K1 extends string, A, B, C>(that: ReadonlyRecord<K1, B>, combine: (selfValue: A, thatValue: B) => C): <K0 extends string>(self: ReadonlyRecord<K0, A>) => Record<ReadonlyRecord.IntersectKeys<K0, K1>, C>
   /**
-   * Merge two records, retaining only the entries that exist in both records.
+   * Merges two records, retaining only the entries that exist in both records.
    * For intersecting keys, the provided combine function is used to merge the values.
    *
    * **Example** (Merging intersecting keys)
@@ -2188,7 +2215,7 @@ export const intersection: {
 )
 
 /**
- * Merge two records, preserving only the entries that are unique to each record.
+ * Merges two records, preserving only the entries that are unique to each record.
  * Keys that exist in both records are excluded from the result.
  *
  * **Example** (Keeping keys unique to each record)
@@ -2208,7 +2235,7 @@ export const intersection: {
  */
 export const difference: {
   /**
-   * Merge two records, preserving only the entries that are unique to each record.
+   * Merges two records, preserving only the entries that are unique to each record.
    * Keys that exist in both records are excluded from the result.
    *
    * **Example** (Keeping keys unique to each record)
@@ -2228,7 +2255,7 @@ export const difference: {
    */
   <K1 extends string, B>(that: ReadonlyRecord<K1, B>): <K0 extends string, A>(self: ReadonlyRecord<K0, A>) => Record<K0 | K1, A | B>
   /**
-   * Merge two records, preserving only the entries that are unique to each record.
+   * Merges two records, preserving only the entries that are unique to each record.
    * Keys that exist in both records are excluded from the result.
    *
    * **Example** (Keeping keys unique to each record)

package/src/Redactable.ts

@@ -71,7 +71,7 @@ import { pipeArguments } from "./Pipeable.ts"
 import { hasProperty } from "./Predicate.ts"
 
 /**
- * Symbol used to identify objects that implement the {@link Redactable}
+ * Defines the symbol used to identify objects that implement the {@link Redactable}
  * protocol.
  *
  * **When to use**
@@ -101,7 +101,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
- * @category symbol
+ * @category symbols
  * @since 3.10.0
  */
 export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
@@ -159,7 +159,7 @@ export interface Redactable {
 export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symbolRedactable)
 
 /**
- * Redacts a value if it implements {@link Redactable}, otherwise returns it
+ * Returns a redacted value if it implements {@link Redactable}, otherwise returns it
  * unchanged.
  *
  * **When to use**
@@ -170,7 +170,7 @@ export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symb
  * **Details**
  *
  * This function calls {@link isRedactable} and, when it returns `true`,
- * delegates to {@link getRedacted}. It does not mutate the input.
+ * delegates to {@link getRedacted}.
  *
  * **Gotchas**
  *
@@ -188,8 +188,8 @@ export function redact(u: unknown): unknown {
 }
 
 /**
- * Calls `[symbolRedactable]` on a value that is already known to be
- * {@link Redactable} and returns the result.
+ * Returns the result of calling `[symbolRedactable]` on a value that is
+ * already known to be {@link Redactable}.
  *
  * **When to use**
  *
@@ -199,7 +199,7 @@ export function redact(u: unknown): unknown {
  * **Details**
  *
  * This function reads the current fiber's `Context` from the global fiber
- * reference and passes it to the redaction method. It does not mutate the input.
+ * reference and passes it to the redaction method.
  *
  * **Gotchas**
  *

package/src/Reducer.ts

@@ -145,7 +145,6 @@ export interface Reducer<A> extends Combiner.Combiner<A> {
  * - If `combineAll` is omitted, a default left-to-right fold starting from
  *   `initialValue` is used.
  * - If `combineAll` is provided, it completely replaces the default fold.
- * - Pure – the returned reducer does not mutate its arguments.
  *
  * **Example** (Multiplication with short-circuit)
  *
@@ -213,7 +212,6 @@ export function make<A>(
  * - The `initialValue` is preserved from the original reducer.
  * - The `combineAll` is re-derived from the flipped `combine` (using the
  *   default left-to-right fold), not carried over from the original.
- * - Does not mutate the input reducer.
  *
  * **Example** (Reversing string concatenation)
  *