effect 3.13.8 → 3.13.9

package/src/Record.ts

@@ -66,10 +66,9 @@ export const empty = <K extends string | symbol = never, V = never>(): Record<
 /**
  * Determine if a record is empty.
  *
- * @param self - record to test for emptiness.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isEmptyRecord } from "effect/Record"
  *
  * assert.deepStrictEqual(isEmptyRecord({}), true);
@@ -85,10 +84,9 @@ export const isEmptyRecord = <K extends string, A>(self: Record<K, A>): self is
 /**
  * Determine if a record is empty.
  *
- * @param self - record to test for emptiness.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { isEmptyReadonlyRecord } from "effect/Record"
  *
  * assert.deepStrictEqual(isEmptyReadonlyRecord({}), true);
@@ -106,11 +104,9 @@ export const isEmptyReadonlyRecord: <K extends string, A>(
  * Takes an iterable and a projection function and returns a record.
  * The projection function maps each value of the iterable to a tuple of a key and a value, which is then added to the resulting record.
  *
- * @param self - An iterable of values to be mapped to a record.
- * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { fromIterableWith } from "effect/Record"
  *
  * const input = [1, 2, 3, 4]
@@ -129,11 +125,9 @@ export const fromIterableWith: {
    * Takes an iterable and a projection function and returns a record.
    * The projection function maps each value of the iterable to a tuple of a key and a value, which is then added to the resulting record.
    *
-   * @param self - An iterable of values to be mapped to a record.
-   * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { fromIterableWith } from "effect/Record"
    *
    * const input = [1, 2, 3, 4]
@@ -152,11 +146,9 @@ export const fromIterableWith: {
    * Takes an iterable and a projection function and returns a record.
    * The projection function maps each value of the iterable to a tuple of a key and a value, which is then added to the resulting record.
    *
-   * @param self - An iterable of values to be mapped to a record.
-   * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { fromIterableWith } from "effect/Record"
    *
    * const input = [1, 2, 3, 4]
@@ -189,11 +181,9 @@ export const fromIterableWith: {
 /**
  * Creates a new record from an iterable, utilizing the provided function to determine the key for each element.
  *
- * @param items - An iterable containing elements.
- * @param f - A function that extracts the key for each element.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { fromIterableBy } from "effect/Record"
  *
  * const users = [
@@ -224,10 +214,9 @@ export const fromIterableBy = <A, K extends string | symbol>(
  * If there are conflicting keys when using `fromEntries`, the last occurrence of the key/value pair will overwrite the
  * previous ones. So the resulting record will only have the value of the last occurrence of each key.
  *
- * @param self - The iterable of key-value pairs.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { fromEntries } from "effect/Record"
  *
  * const input: Array<[string, number]> = [["a", 1], ["b", 2]]
@@ -245,11 +234,9 @@ export const fromEntries: <Entry extends readonly [string | symbol, any]>(
 /**
  * Transforms the values of a record into an `Array` with a custom mapping function.
  *
- * @param self - The record to transform.
- * @param f - The custom mapping function to apply to each key/value of the record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { collect } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3 }
@@ -263,11 +250,9 @@ export const collect: {
   /**
    * Transforms the values of a record into an `Array` with a custom mapping function.
    *
-   * @param self - The record to transform.
-   * @param f - The custom mapping function to apply to each key/value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { collect } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -281,11 +266,9 @@ export const collect: {
   /**
    * Transforms the values of a record into an `Array` with a custom mapping function.
    *
-   * @param self - The record to transform.
-   * @param f - The custom mapping function to apply to each key/value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { collect } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -310,10 +293,9 @@ export const collect: {
 /**
  * Takes a record and returns an array of tuples containing its keys and values.
  *
- * @param self - The record to transform.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { toEntries } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3 }
@@ -331,10 +313,9 @@ export const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>) => Arr
 /**
  * Returns the number of key/value pairs in a record.
  *
- * @param self - A record to calculate the number of key/value pairs in.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { size } from "effect/Record";
  *
  * assert.deepStrictEqual(size({ a: "a", b: 1, c: true }), 3);
@@ -347,11 +328,9 @@ export const size = <K extends string, A>(self: ReadonlyRecord<K, A>): number =>
 /**
  * Check if a given `key` exists in a record.
  *
- * @param self - the record to look in.
- * @param key - the key to look for in the record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { empty, has } from "effect/Record"
  *
  * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
@@ -364,11 +343,9 @@ export const has: {
   /**
    * Check if a given `key` exists in a record.
    *
-   * @param self - the record to look in.
-   * @param key - the key to look for in the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { empty, has } from "effect/Record"
    *
    * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
@@ -381,11 +358,9 @@ export const has: {
   /**
    * Check if a given `key` exists in a record.
    *
-   * @param self - the record to look in.
-   * @param key - the key to look for in the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { empty, has } from "effect/Record"
    *
    * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
@@ -406,11 +381,9 @@ export const has: {
 /**
  * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
  *
- * @param self - The record to retrieve value from.
- * @param key - Key to retrieve from record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record as R, Option } from "effect"
  *
  * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
@@ -425,11 +398,9 @@ export const get: {
   /**
    * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
    *
-   * @param self - The record to retrieve value from.
-   * @param key - Key to retrieve from record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
@@ -444,11 +415,9 @@ export const get: {
   /**
    * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`.
    *
-   * @param self - The record to retrieve value from.
-   * @param key - Key to retrieve from record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
@@ -470,12 +439,9 @@ export const get: {
  * Apply a function to the element at the specified key, creating a new record.
  * If the key does not exist, the record is returned unchanged.
  *
- * @param self - The record to be updated.
- * @param key - The key of the element to modify.
- * @param f - The function to apply to the element.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record as R } from "effect"
  *
  * const f = (x: number) => x * 2
@@ -497,12 +463,9 @@ export const modify: {
    * Apply a function to the element at the specified key, creating a new record.
    * If the key does not exist, the record is returned unchanged.
    *
-   * @param self - The record to be updated.
-   * @param key - The key of the element to modify.
-   * @param f - The function to apply to the element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -524,12 +487,9 @@ export const modify: {
    * Apply a function to the element at the specified key, creating a new record.
    * If the key does not exist, the record is returned unchanged.
    *
-   * @param self - The record to be updated.
-   * @param key - The key of the element to modify.
-   * @param f - The function to apply to the element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -561,12 +521,9 @@ export const modify: {
  * Apply a function to the element at the specified key, creating a new record,
  * or return `None` if the key doesn't exist.
  *
- * @param self - The record to be updated.
- * @param key - The key of the element to modify.
- * @param f - The function to apply to the element.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record as R, Option } from "effect"
  *
  * const f = (x: number) => x * 2
@@ -588,12 +545,9 @@ export const modifyOption: {
    * Apply a function to the element at the specified key, creating a new record,
    * or return `None` if the key doesn't exist.
    *
-   * @param self - The record to be updated.
-   * @param key - The key of the element to modify.
-   * @param f - The function to apply to the element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -615,12 +569,9 @@ export const modifyOption: {
    * Apply a function to the element at the specified key, creating a new record,
    * or return `None` if the key doesn't exist.
    *
-   * @param self - The record to be updated.
-   * @param key - The key of the element to modify.
-   * @param f - The function to apply to the element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -655,12 +606,9 @@ export const modifyOption: {
 /**
  * Replaces a value in the record with the new value passed as parameter.
  *
- * @param self - The record to be updated.
- * @param key - The key to search for in the record.
- * @param b - The new value to replace the existing value with.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -676,12 +624,9 @@ export const replaceOption: {
   /**
    * Replaces a value in the record with the new value passed as parameter.
    *
-   * @param self - The record to be updated.
-   * @param key - The key to search for in the record.
-   * @param b - The new value to replace the existing value with.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -697,12 +642,9 @@ export const replaceOption: {
   /**
    * Replaces a value in the record with the new value passed as parameter.
    *
-   * @param self - The record to be updated.
-   * @param key - The key to search for in the record.
-   * @param b - The new value to replace the existing value with.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -728,11 +670,9 @@ export const replaceOption: {
  * If the given key exists in the record, returns a new record with the key removed,
  * otherwise returns a copy of the original record.
  *
- * @param self - the record to remove the key from.
- * @param key - the key to remove from the record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { remove } from "effect/Record"
  *
  * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
@@ -745,11 +685,9 @@ export const remove: {
    * If the given key exists in the record, returns a new record with the key removed,
    * otherwise returns a copy of the original record.
    *
-   * @param self - the record to remove the key from.
-   * @param key - the key to remove from the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { remove } from "effect/Record"
    *
    * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
@@ -762,11 +700,9 @@ export const remove: {
    * If the given key exists in the record, returns a new record with the key removed,
    * otherwise returns a copy of the original record.
    *
-   * @param self - the record to remove the key from.
-   * @param key - the key to remove from the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { remove } from "effect/Record"
    *
    * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
@@ -792,11 +728,9 @@ export const remove: {
  * of a tuple with the value and the record with the removed property.
  * If the key is not present, returns `O.none`.
  *
- * @param self - The input record.
- * @param key - The key of the property to retrieve.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record as R, Option } from "effect"
  *
  * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
@@ -812,11 +746,9 @@ export const pop: {
    * of a tuple with the value and the record with the removed property.
    * If the key is not present, returns `O.none`.
    *
-   * @param self - The input record.
-   * @param key - The key of the property to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
@@ -832,11 +764,9 @@ export const pop: {
    * of a tuple with the value and the record with the removed property.
    * If the key is not present, returns `O.none`.
    *
-   * @param self - The input record.
-   * @param key - The key of the property to retrieve.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record as R, Option } from "effect"
    *
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
@@ -856,11 +786,9 @@ export const pop: {
 /**
  * Maps a record into another record by applying a transformation function to each of its values.
  *
- * @param self - The record to be mapped.
- * @param f - A transformation function that will be applied to each of the values in the record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { map } from "effect/Record"
  *
  * const f = (n: number) => `-${n}`
@@ -879,11 +807,9 @@ export const map: {
   /**
    * Maps a record into another record by applying a transformation function to each of its values.
    *
-   * @param self - The record to be mapped.
-   * @param f - A transformation function that will be applied to each of the values in the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { map } from "effect/Record"
    *
    * const f = (n: number) => `-${n}`
@@ -902,11 +828,9 @@ export const map: {
   /**
    * Maps a record into another record by applying a transformation function to each of its values.
    *
-   * @param self - The record to be mapped.
-   * @param f - A transformation function that will be applied to each of the values in the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { map } from "effect/Record"
    *
    * const f = (n: number) => `-${n}`
@@ -938,6 +862,7 @@ export const map: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { mapKeys } from "effect/Record"
  *
  * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
@@ -952,6 +877,7 @@ export const mapKeys: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { mapKeys } from "effect/Record"
    *
    * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
@@ -966,6 +892,7 @@ export const mapKeys: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { mapKeys } from "effect/Record"
    *
    * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
@@ -995,6 +922,7 @@ export const mapKeys: {
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { mapEntries } from "effect/Record"
  *
  * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
@@ -1009,6 +937,7 @@ export const mapEntries: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { mapEntries } from "effect/Record"
    *
    * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
@@ -1023,6 +952,7 @@ export const mapEntries: {
    *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { mapEntries } from "effect/Record"
    *
    * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
@@ -1051,11 +981,9 @@ export const mapEntries: {
  * Transforms a record into a record by applying the function `f` to each key and value in the original record.
  * If the function returns `Some`, the key-value pair is included in the output record.
  *
- * @param self - The input record.
- * @param f - The transformation function.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Option } from "effect"
  *
  * const x = { a: 1, b: 2, c: 3 }
@@ -1070,11 +998,9 @@ export const filterMap: {
    * Transforms a record into a record by applying the function `f` to each key and value in the original record.
    * If the function returns `Some`, the key-value pair is included in the output record.
    *
-   * @param self - The input record.
-   * @param f - The transformation function.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Option } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -1089,11 +1015,9 @@ export const filterMap: {
    * Transforms a record into a record by applying the function `f` to each key and value in the original record.
    * If the function returns `Some`, the key-value pair is included in the output record.
    *
-   * @param self - The input record.
-   * @param f - The transformation function.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Option } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -1124,11 +1048,9 @@ export const filterMap: {
 /**
  * Selects properties from a record whose values match the given predicate.
  *
- * @param self - The record to filter.
- * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { filter } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3, d: 4 }
@@ -1142,11 +1064,9 @@ export const filter: {
   /**
    * Selects properties from a record whose values match the given predicate.
    *
-   * @param self - The record to filter.
-   * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
@@ -1160,11 +1080,9 @@ export const filter: {
   /**
    * Selects properties from a record whose values match the given predicate.
    *
-   * @param self - The record to filter.
-   * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
@@ -1178,11 +1096,9 @@ export const filter: {
   /**
    * Selects properties from a record whose values match the given predicate.
    *
-   * @param self - The record to filter.
-   * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
@@ -1196,11 +1112,9 @@ export const filter: {
   /**
    * Selects properties from a record whose values match the given predicate.
    *
-   * @param self - The record to filter.
-   * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
@@ -1230,10 +1144,9 @@ export const filter: {
 /**
  * Given a record with `Option` values, returns a new record containing only the `Some` values, preserving the original keys.
  *
- * @param self - A record with `Option` values.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -1256,6 +1169,7 @@ export const getSomes: <K extends string, A>(
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
@@ -1286,6 +1200,7 @@ export const getLefts = <K extends string, R, L>(
  *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
@@ -1314,11 +1229,9 @@ export const getRights = <K extends string, R, L>(
 /**
  * Partitions the elements of a record into two groups: those that match a predicate, and those that don't.
  *
- * @param self - The record to partition.
- * @param f - The predicate function to apply to each element.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Either } from "effect"
  *
  * const x = { a: 1, b: 2, c: 3 }
@@ -1333,11 +1246,9 @@ export const partitionMap: {
   /**
    * Partitions the elements of a record into two groups: those that match a predicate, and those that don't.
    *
-   * @param self - The record to partition.
-   * @param f - The predicate function to apply to each element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Either } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -1354,11 +1265,9 @@ export const partitionMap: {
   /**
    * Partitions the elements of a record into two groups: those that match a predicate, and those that don't.
    *
-   * @param self - The record to partition.
-   * @param f - The predicate function to apply to each element.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record, Either } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
@@ -1394,10 +1303,9 @@ export const partitionMap: {
  * Partitions a record of `Either` values into two separate records,
  * one with the `Left` values and one with the `Right` values.
  *
- * @param self - the record to partition.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
@@ -1416,11 +1324,9 @@ export const separate: <K extends string, A, B>(
 /**
  * Partitions a record into two separate records based on the result of a predicate function.
  *
- * @param self - The input record to partition.
- * @param predicate - The partitioning function to determine the partitioning of each value of the record.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { partition } from "effect/Record"
  *
  * assert.deepStrictEqual(
@@ -1436,11 +1342,9 @@ export const partition: {
   /**
    * Partitions a record into two separate records based on the result of a predicate function.
    *
-   * @param self - The input record to partition.
-   * @param predicate - The partitioning function to determine the partitioning of each value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
@@ -1461,11 +1365,9 @@ export const partition: {
   /**
    * Partitions a record into two separate records based on the result of a predicate function.
    *
-   * @param self - The input record to partition.
-   * @param predicate - The partitioning function to determine the partitioning of each value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
@@ -1483,11 +1385,9 @@ export const partition: {
   /**
    * Partitions a record into two separate records based on the result of a predicate function.
    *
-   * @param self - The input record to partition.
-   * @param predicate - The partitioning function to determine the partitioning of each value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
@@ -1506,11 +1406,9 @@ export const partition: {
   /**
    * Partitions a record into two separate records based on the result of a predicate function.
    *
-   * @param self - The input record to partition.
-   * @param predicate - The partitioning function to determine the partitioning of each value of the record.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
@@ -1545,8 +1443,6 @@ export const partition: {
 /**
  * Retrieve the keys of a given record as an array.
  *
- * @param self - The object for which you want to get the keys.
- *
  * @since 2.0.0
  */
 export const keys = <K extends string | symbol, A>(self: ReadonlyRecord<K, A>): Array<K & string> =>
@@ -1555,8 +1451,6 @@ export const keys = <K extends string | symbol, A>(self: ReadonlyRecord<K, A>):
 /**
  * Retrieve the values of a given record as an array.
  *
- * @param self - The object for which you want to get the values.
- *
  * @since 2.0.0
  */
 export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A> => collect(self, (_, a) => a)
@@ -1564,12 +1458,9 @@ export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A
 /**
  * Add a new key-value pair or update an existing key's value in a record.
  *
- * @param self - The record to which you want to add or update a key-value pair.
- * @param key - The key you want to add or update.
- * @param values - The value you want to associate with the key.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { set } from "effect/Record"
  *
  * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
@@ -1582,12 +1473,9 @@ export const set: {
   /**
    * Add a new key-value pair or update an existing key's value in a record.
    *
-   * @param self - The record to which you want to add or update a key-value pair.
-   * @param key - The key you want to add or update.
-   * @param values - The value you want to associate with the key.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { set } from "effect/Record"
    *
    * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
@@ -1600,12 +1488,9 @@ export const set: {
   /**
    * Add a new key-value pair or update an existing key's value in a record.
    *
-   * @param self - The record to which you want to add or update a key-value pair.
-   * @param key - The key you want to add or update.
-   * @param values - The value you want to associate with the key.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { set } from "effect/Record"
    *
    * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
@@ -1630,12 +1515,9 @@ export const set: {
  * Replace a key's value in a record and return the updated record.
  * If the key does not exist in the record, a copy of the original record is returned.
  *
- * @param self - The original record.
- * @param key - The key to replace.
- * @param value - The new value to associate with the key.
- *
  * @example
  * ```ts
+ * import * as assert from "node:assert"
  * import { Record } from "effect"
  *
  * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
@@ -1649,12 +1531,9 @@ export const replace: {
    * Replace a key's value in a record and return the updated record.
    * If the key does not exist in the record, a copy of the original record is returned.
    *
-   * @param self - The original record.
-   * @param key - The key to replace.
-   * @param value - The new value to associate with the key.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record } from "effect"
    *
    * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
@@ -1668,12 +1547,9 @@ export const replace: {
    * Replace a key's value in a record and return the updated record.
    * If the key does not exist in the record, a copy of the original record is returned.
    *
-   * @param self - The original record.
-   * @param key - The key to replace.
-   * @param value - The new value to associate with the key.
-   *
    * @example
    * ```ts
+   * import * as assert from "node:assert"
    * import { Record } from "effect"
    *
    * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
@@ -1696,10 +1572,6 @@ export const replace: {
 /**
  * Check if all the keys and values in one record are also found in another record.
  *
- * @param self - The first record to check.
- * @param that - The second record to compare against.
- * @param equivalence - A function to compare values.
- *
  * @since 2.0.0
  */
 export const isSubrecordBy = <A>(equivalence: Equivalence<A>): {
@@ -1719,9 +1591,6 @@ export const isSubrecordBy = <A>(equivalence: Equivalence<A>): {
  * Check if one record is a subrecord of another, meaning it contains all the keys and values found in the second record.
  * This comparison uses default equality checks (`Equal.equivalence()`).
  *
- * @param self - The first record to check.
- * @param that - The second record to compare against.
- *
  * @since 2.0.0
  */
 export const isSubrecord: {
@@ -1729,9 +1598,6 @@ export const isSubrecord: {
    * Check if one record is a subrecord of another, meaning it contains all the keys and values found in the second record.
    * This comparison uses default equality checks (`Equal.equivalence()`).
    *
-   * @param self - The first record to check.
-   * @param that - The second record to compare against.
-   *
    * @since 2.0.0
    */
   <K extends string, A>(that: ReadonlyRecord<K, A>): (self: ReadonlyRecord<K, A>) => boolean
@@ -1739,9 +1605,6 @@ export const isSubrecord: {
    * Check if one record is a subrecord of another, meaning it contains all the keys and values found in the second record.
    * This comparison uses default equality checks (`Equal.equivalence()`).
    *
-   * @param self - The first record to check.
-   * @param that - The second record to compare against.
-   *
    * @since 2.0.0
    */
   <K extends string, A>(self: ReadonlyRecord<K, A>, that: ReadonlyRecord<K, A>): boolean
@@ -1750,10 +1613,6 @@ export const isSubrecord: {
 /**
  * Reduce a record to a single value by combining its entries with a specified function.
  *
- * @param self - The record to reduce.
- * @param zero - The initial value of the accumulator.
- * @param f - The function to combine entries (accumulator, value, key).
- *
  * @category folding
  * @since 2.0.0
  */
@@ -1761,10 +1620,6 @@ export const reduce: {
   /**
    * Reduce a record to a single value by combining its entries with a specified function.
    *
-   * @param self - The record to reduce.
-   * @param zero - The initial value of the accumulator.
-   * @param f - The function to combine entries (accumulator, value, key).
-   *
    * @category folding
    * @since 2.0.0
    */
@@ -1772,10 +1627,6 @@ export const reduce: {
   /**
    * Reduce a record to a single value by combining its entries with a specified function.
    *
-   * @param self - The record to reduce.
-   * @param zero - The initial value of the accumulator.
-   * @param f - The function to combine entries (accumulator, value, key).
-   *
    * @category folding
    * @since 2.0.0
    */
@@ -1802,45 +1653,30 @@ export const reduce: {
 /**
  * Check if all entries in a record meet a specific condition.
  *
- * @param self - The record to check.
- * @param predicate - The condition to test entries (value, key).
- *
  * @since 2.0.0
  */
 export const every: {
   /**
    * Check if all entries in a record meet a specific condition.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <K extends string, A>(self: ReadonlyRecord<K, A>, predicate: (value: A, key: K) => boolean): boolean
@@ -1862,27 +1698,18 @@ export const every: {
 /**
  * Check if any entry in a record meets a specific condition.
  *
- * @param self - The record to check.
- * @param predicate - The condition to test entries (value, key).
- *
  * @since 2.0.0
  */
 export const some: {
   /**
    * Check if any entry in a record meets a specific condition.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The record to check.
-   * @param predicate - The condition to test entries (value, key).
-   *
    * @since 2.0.0
    */
   <K extends string, A>(self: ReadonlyRecord<K, A>, predicate: (value: A, key: K) => boolean): boolean
@@ -1901,30 +1728,18 @@ export const some: {
 /**
  * Merge two records, preserving entries that exist in either of the records.
  *
- * @param self - The first record.
- * @param that - The second record to combine with the first.
- * @param combine - A function to specify how to merge entries with the same key.
- *
  * @since 2.0.0
  */
 export const union: {
   /**
    * Merge two records, preserving entries that exist in either of the records.
    *
-   * @param self - The first record.
-   * @param that - The second record to combine with the first.
-   * @param combine - A function to specify how to merge entries with the same key.
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The first record.
-   * @param that - The second record to combine with the first.
-   * @param combine - A function to specify how to merge entries with the same key.
-   *
    * @since 2.0.0
    */
   <K0 extends string, A, K1 extends string, B, C>(
@@ -1965,30 +1780,18 @@ export const union: {
 /**
  * Merge two records, retaining only the entries that exist in both records.
  *
- * @param self - The first record.
- * @param that - The second record to merge with the first.
- * @param combine - A function to specify how to merge entries with the same key.
- *
  * @since 2.0.0
  */
 export const intersection: {
   /**
    * Merge two records, retaining only the entries that exist in both records.
    *
-   * @param self - The first record.
-   * @param that - The second record to merge with the first.
-   * @param combine - A function to specify how to merge entries with the same key.
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The first record.
-   * @param that - The second record to merge with the first.
-   * @param combine - A function to specify how to merge entries with the same key.
-   *
    * @since 2.0.0
    */
   <K0 extends string, A, K1 extends string, B, C>(
@@ -2019,27 +1822,18 @@ export const intersection: {
 /**
  * Merge two records, preserving only the entries that are unique to each record.
  *
- * @param self - The first record.
- * @param that - The second record to compare with the first.
- *
  * @since 2.0.0
  */
 export const difference: {
   /**
    * Merge two records, preserving only the entries that are unique to each record.
    *
-   * @param self - The first record.
-   * @param that - The second record to compare with the first.
-   *
    * @since 2.0.0
    */
   <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.
    *
-   * @param self - The first record.
-   * @param that - The second record to compare with the first.
-   *
    * @since 2.0.0
    */
   <K0 extends string, A, K1 extends string, B>(self: ReadonlyRecord<K0, A>, that: ReadonlyRecord<K1, B>): Record<K0 | K1, A | B>
@@ -2070,8 +1864,6 @@ export const difference: {
 /**
  * Create an `Equivalence` for records using the provided `Equivalence` for values.
  *
- * @param equivalence - An `Equivalence` for the values contained in the records.
- *
  * @category instances
  * @since 2.0.0
  */
@@ -2085,9 +1877,6 @@ export const getEquivalence = <K extends string, A>(
 /**
  * Create a non-empty record from a single element.
  *
- * @param key - The key for the element.
- * @param value - The value associated with the key.
- *
  * @category constructors
  * @since 2.0.0
  */