effect 3.10.18 → 3.11.0

package/src/Record.ts

@@ -69,10 +69,12 @@ export const empty = <K extends string | symbol = never, V = never>(): Record<
  * @param self - record to test for emptiness.
  *
  * @example
+ * ```ts
  * import { isEmptyRecord } from "effect/Record"
  *
  * assert.deepStrictEqual(isEmptyRecord({}), true);
  * assert.deepStrictEqual(isEmptyRecord({ a: 3 }), false);
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -86,10 +88,12 @@ export const isEmptyRecord = <K extends string, A>(self: Record<K, A>): self is
  * @param self - record to test for emptiness.
  *
  * @example
+ * ```ts
  * import { isEmptyReadonlyRecord } from "effect/Record"
  *
  * assert.deepStrictEqual(isEmptyReadonlyRecord({}), true);
  * assert.deepStrictEqual(isEmptyReadonlyRecord({ a: 3 }), false);
+ * ```
  *
  * @category guards
  * @since 2.0.0
@@ -106,6 +110,7 @@ export const isEmptyReadonlyRecord: <K extends string, A>(
  * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
  *
  * @example
+ * ```ts
  * import { fromIterableWith } from "effect/Record"
  *
  * const input = [1, 2, 3, 4]
@@ -114,6 +119,7 @@ export const isEmptyReadonlyRecord: <K extends string, A>(
  *   fromIterableWith(input, a => [String(a), a * 2]),
  *   { '1': 2, '2': 4, '3': 6, '4': 8 }
  * )
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -127,6 +133,7 @@ export const fromIterableWith: {
    * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
    *
    * @example
+   * ```ts
    * import { fromIterableWith } from "effect/Record"
    *
    * const input = [1, 2, 3, 4]
@@ -135,6 +142,7 @@ export const fromIterableWith: {
    *   fromIterableWith(input, a => [String(a), a * 2]),
    *   { '1': 2, '2': 4, '3': 6, '4': 8 }
    * )
+   * ```
    *
    * @category constructors
    * @since 2.0.0
@@ -150,6 +158,7 @@ export const fromIterableWith: {
    * @param f - A projection function that maps values of the iterable to a tuple of a key and a value.
    *
    * @example
+   * ```ts
    * import { fromIterableWith } from "effect/Record"
    *
    * const input = [1, 2, 3, 4]
@@ -158,6 +167,7 @@ export const fromIterableWith: {
    *   fromIterableWith(input, a => [String(a), a * 2]),
    *   { '1': 2, '2': 4, '3': 6, '4': 8 }
    * )
+   * ```
    *
    * @category constructors
    * @since 2.0.0
@@ -188,6 +198,7 @@ export const fromIterableWith: {
  * @param f - A function that extracts the key for each element.
  *
  * @example
+ * ```ts
  * import { fromIterableBy } from "effect/Record"
  *
  * const users = [
@@ -202,6 +213,7 @@ export const fromIterableWith: {
  *     "1": { id: "1", name: "name1" }
  *   }
  * )
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -220,11 +232,13 @@ export const fromIterableBy = <A, K extends string | symbol>(
  * @param self - The iterable of key-value pairs.
  *
  * @example
+ * ```ts
  * import { fromEntries } from "effect/Record"
  *
  * const input: Array<[string, number]> = [["a", 1], ["b", 2]]
  *
  * assert.deepStrictEqual(fromEntries(input), { a: 1, b: 2 })
+ * ```
  *
  * @since 2.0.0
  * @category constructors
@@ -240,10 +254,12 @@ export const fromEntries: <Entry extends readonly [string | symbol, any]>(
  * @param f - The custom mapping function to apply to each key/value of the record.
  *
  * @example
+ * ```ts
  * import { collect } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3 }
  * assert.deepStrictEqual(collect(x, (key, n) => [key, n]), [["a", 1], ["b", 2], ["c", 3]])
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -256,10 +272,12 @@ export const collect: {
    * @param f - The custom mapping function to apply to each key/value of the record.
    *
    * @example
+   * ```ts
    * import { collect } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * assert.deepStrictEqual(collect(x, (key, n) => [key, n]), [["a", 1], ["b", 2], ["c", 3]])
+   * ```
    *
    * @category conversions
    * @since 2.0.0
@@ -272,10 +290,12 @@ export const collect: {
    * @param f - The custom mapping function to apply to each key/value of the record.
    *
    * @example
+   * ```ts
    * import { collect } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * assert.deepStrictEqual(collect(x, (key, n) => [key, n]), [["a", 1], ["b", 2], ["c", 3]])
+   * ```
    *
    * @category conversions
    * @since 2.0.0
@@ -298,10 +318,12 @@ export const collect: {
  * @param self - The record to transform.
  *
  * @example
+ * ```ts
  * import { toEntries } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3 }
  * assert.deepStrictEqual(toEntries(x), [["a", 1], ["b", 2], ["c", 3]])
+ * ```
  *
  * @category conversions
  * @since 2.0.0
@@ -317,9 +339,11 @@ export const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>) => Arr
  * @param self - A record to calculate the number of key/value pairs in.
  *
  * @example
+ * ```ts
  * import { size } from "effect/Record";
  *
  * assert.deepStrictEqual(size({ a: "a", b: 1, c: true }), 3);
+ * ```
  *
  * @since 2.0.0
  */
@@ -332,10 +356,12 @@ export const size = <K extends string, A>(self: ReadonlyRecord<K, A>): number =>
  * @param key - the key to look for in the record.
  *
  * @example
+ * ```ts
  * import { empty, has } from "effect/Record"
  *
  * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
  * assert.deepStrictEqual(has(empty<string>(), "c"), false);
+ * ```
  *
  * @since 2.0.0
  */
@@ -347,10 +373,12 @@ export const has: {
    * @param key - the key to look for in the record.
    *
    * @example
+   * ```ts
    * import { empty, has } from "effect/Record"
    *
    * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
    * assert.deepStrictEqual(has(empty<string>(), "c"), false);
+   * ```
    *
    * @since 2.0.0
    */
@@ -362,10 +390,12 @@ export const has: {
    * @param key - the key to look for in the record.
    *
    * @example
+   * ```ts
    * import { empty, has } from "effect/Record"
    *
    * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true);
    * assert.deepStrictEqual(has(empty<string>(), "c"), false);
+   * ```
    *
    * @since 2.0.0
    */
@@ -385,12 +415,14 @@ export const has: {
  * @param key - Key to retrieve from record.
  *
  * @example
+ * ```ts
  * import { Record as R, Option } from "effect"
  *
  * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
  *
  * assert.deepStrictEqual(R.get(person, "name"), Option.some("John Doe"))
  * assert.deepStrictEqual(R.get(person, "email"), Option.none())
+ * ```
  *
  * @since 2.0.0
  */
@@ -402,12 +434,14 @@ export const get: {
    * @param key - Key to retrieve from record.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
    *
    * assert.deepStrictEqual(R.get(person, "name"), Option.some("John Doe"))
    * assert.deepStrictEqual(R.get(person, "email"), Option.none())
+   * ```
    *
    * @since 2.0.0
    */
@@ -419,12 +453,14 @@ export const get: {
    * @param key - Key to retrieve from record.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * const person: Record<string, unknown> = { name: "John Doe", age: 35 }
    *
    * assert.deepStrictEqual(R.get(person, "name"), Option.some("John Doe"))
    * assert.deepStrictEqual(R.get(person, "email"), Option.none())
+   * ```
    *
    * @since 2.0.0
    */
@@ -444,6 +480,7 @@ export const get: {
  * @param f - The function to apply to the element.
  *
  * @example
+ * ```ts
  * import { Record as R } from "effect"
  *
  * const f = (x: number) => x * 2
@@ -456,6 +493,7 @@ export const get: {
  *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
  *  { a: 3 }
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -469,6 +507,7 @@ export const modify: {
    * @param f - The function to apply to the element.
    *
    * @example
+   * ```ts
    * import { Record as R } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -481,6 +520,7 @@ export const modify: {
    *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
    *  { a: 3 }
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -494,6 +534,7 @@ export const modify: {
    * @param f - The function to apply to the element.
    *
    * @example
+   * ```ts
    * import { Record as R } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -506,6 +547,7 @@ export const modify: {
    *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
    *  { a: 3 }
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -529,6 +571,7 @@ export const modify: {
  * @param f - The function to apply to the element.
  *
  * @example
+ * ```ts
  * import { Record as R, Option } from "effect"
  *
  * const f = (x: number) => x * 2
@@ -541,6 +584,7 @@ export const modify: {
  *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
  *  Option.none()
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -554,6 +598,7 @@ export const modifyOption: {
    * @param f - The function to apply to the element.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -566,6 +611,7 @@ export const modifyOption: {
    *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
    *  Option.none()
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -582,6 +628,7 @@ export const modifyOption: {
    * @param f - The function to apply to the element.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * const f = (x: number) => x * 2
@@ -594,6 +641,7 @@ export const modifyOption: {
    *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
    *  Option.none()
    * )
+   * ```
    *
    * @since 2.0.0
    */
@@ -624,6 +672,7 @@ export const modifyOption: {
  * @param b - The new value to replace the existing value with.
  *
  * @example
+ * ```ts
  * import { Record, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -631,6 +680,7 @@ export const modifyOption: {
  *   Option.some({ a: 10, b: 2, c: 3 })
  * )
  * assert.deepStrictEqual(Record.replaceOption(Record.empty<string>(), 'a', 10), Option.none())
+ * ```
  *
  * @since 2.0.0
  */
@@ -643,6 +693,7 @@ export const replaceOption: {
    * @param b - The new value to replace the existing value with.
    *
    * @example
+   * ```ts
    * import { Record, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -650,6 +701,7 @@ export const replaceOption: {
    *   Option.some({ a: 10, b: 2, c: 3 })
    * )
    * assert.deepStrictEqual(Record.replaceOption(Record.empty<string>(), 'a', 10), Option.none())
+   * ```
    *
    * @since 2.0.0
    */
@@ -665,6 +717,7 @@ export const replaceOption: {
    * @param b - The new value to replace the existing value with.
    *
    * @example
+   * ```ts
    * import { Record, Option } from "effect"
    *
    * assert.deepStrictEqual(
@@ -672,6 +725,7 @@ export const replaceOption: {
    *   Option.some({ a: 10, b: 2, c: 3 })
    * )
    * assert.deepStrictEqual(Record.replaceOption(Record.empty<string>(), 'a', 10), Option.none())
+   * ```
    *
    * @since 2.0.0
    */
@@ -693,9 +747,11 @@ export const replaceOption: {
  * @param key - the key to remove from the record.
  *
  * @example
+ * ```ts
  * import { remove } from "effect/Record"
  *
  * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -708,9 +764,11 @@ export const remove: {
    * @param key - the key to remove from the record.
    *
    * @example
+   * ```ts
    * import { remove } from "effect/Record"
    *
    * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -723,9 +781,11 @@ export const remove: {
    * @param key - the key to remove from the record.
    *
    * @example
+   * ```ts
    * import { remove } from "effect/Record"
    *
    * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -751,10 +811,12 @@ export const remove: {
  * @param key - The key of the property to retrieve.
  *
  * @example
+ * ```ts
  * import { Record as R, Option } from "effect"
  *
  * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
  * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record<string, number>, "c"), Option.none())
+ * ```
  *
  * @category record
  * @since 2.0.0
@@ -769,10 +831,12 @@ export const pop: {
    * @param key - The key of the property to retrieve.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record<string, number>, "c"), Option.none())
+   * ```
    *
    * @category record
    * @since 2.0.0
@@ -789,10 +853,12 @@ export const pop: {
    * @param key - The key of the property to retrieve.
    *
    * @example
+   * ```ts
    * import { Record as R, Option } from "effect"
    *
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 }, "a"), Option.some([1, { b: 2 }]))
    * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record<string, number>, "c"), Option.none())
+   * ```
    *
    * @category record
    * @since 2.0.0
@@ -814,6 +880,7 @@ export const pop: {
  * @param f - A transformation function that will be applied to each of the values in the record.
  *
  * @example
+ * ```ts
  * import { map } from "effect/Record"
  *
  * const f = (n: number) => `-${n}`
@@ -823,6 +890,7 @@ export const pop: {
  * const g = (n: number, key: string) => `${key.toUpperCase()}-${n}`
  *
  * assert.deepStrictEqual(map({ a: 3, b: 5 }, g), { a: "A-3", b: "B-5" })
+ * ```
  *
  * @category mapping
  * @since 2.0.0
@@ -835,6 +903,7 @@ export const map: {
    * @param f - A transformation function that will be applied to each of the values in the record.
    *
    * @example
+   * ```ts
    * import { map } from "effect/Record"
    *
    * const f = (n: number) => `-${n}`
@@ -844,6 +913,7 @@ export const map: {
    * const g = (n: number, key: string) => `${key.toUpperCase()}-${n}`
    *
    * assert.deepStrictEqual(map({ a: 3, b: 5 }, g), { a: "A-3", b: "B-5" })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -856,6 +926,7 @@ export const map: {
    * @param f - A transformation function that will be applied to each of the values in the record.
    *
    * @example
+   * ```ts
    * import { map } from "effect/Record"
    *
    * const f = (n: number) => `-${n}`
@@ -865,6 +936,7 @@ export const map: {
    * const g = (n: number, key: string) => `${key.toUpperCase()}-${n}`
    *
    * assert.deepStrictEqual(map({ a: 3, b: 5 }, g), { a: "A-3", b: "B-5" })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -885,9 +957,11 @@ export const map: {
  * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values.
  *
  * @example
+ * ```ts
  * import { mapKeys } from "effect/Record"
  *
  * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
+ * ```
  *
  * @category mapping
  * @since 2.0.0
@@ -897,9 +971,11 @@ export const mapKeys: {
    * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values.
    *
    * @example
+   * ```ts
    * import { mapKeys } from "effect/Record"
    *
    * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -909,9 +985,11 @@ export const mapKeys: {
    * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values.
    *
    * @example
+   * ```ts
    * import { mapKeys } from "effect/Record"
    *
    * assert.deepStrictEqual(mapKeys({ a: 3, b: 5 }, (key) => key.toUpperCase()), { A: 3, B: 5 })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -936,9 +1014,11 @@ export const mapKeys: {
  * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values.
  *
  * @example
+ * ```ts
  * import { mapEntries } from "effect/Record"
  *
  * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
+ * ```
  *
  * @category mapping
  * @since 2.0.0
@@ -948,9 +1028,11 @@ export const mapEntries: {
    * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values.
    *
    * @example
+   * ```ts
    * import { mapEntries } from "effect/Record"
    *
    * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -962,9 +1044,11 @@ export const mapEntries: {
    * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values.
    *
    * @example
+   * ```ts
    * import { mapEntries } from "effect/Record"
    *
    * assert.deepStrictEqual(mapEntries({ a: 3, b: 5 }, (a, key) => [key.toUpperCase(), a + 1]), { A: 4, B: 6 })
+   * ```
    *
    * @category mapping
    * @since 2.0.0
@@ -993,11 +1077,13 @@ export const mapEntries: {
  * @param f - The transformation function.
  *
  * @example
+ * ```ts
  * import { Record, Option } from "effect"
  *
  * const x = { a: 1, b: 2, c: 3 }
  * const f = (a: number, key: string) => a > 2 ? Option.some(a * 2) : Option.none()
  * assert.deepStrictEqual(Record.filterMap(x, f), { c: 6 })
+ * ```
  *
  * @since 2.0.0
  */
@@ -1010,11 +1096,13 @@ export const filterMap: {
    * @param f - The transformation function.
    *
    * @example
+   * ```ts
    * import { Record, Option } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * const f = (a: number, key: string) => a > 2 ? Option.some(a * 2) : Option.none()
    * assert.deepStrictEqual(Record.filterMap(x, f), { c: 6 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -1029,11 +1117,13 @@ export const filterMap: {
    * @param f - The transformation function.
    *
    * @example
+   * ```ts
    * import { Record, Option } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * const f = (a: number, key: string) => a > 2 ? Option.some(a * 2) : Option.none()
    * assert.deepStrictEqual(Record.filterMap(x, f), { c: 6 })
+   * ```
    *
    * @since 2.0.0
    */
@@ -1065,10 +1155,12 @@ export const filterMap: {
  * @param predicate - A function that returns a `boolean` value to determine if the entry should be included in the new record.
  *
  * @example
+ * ```ts
  * import { filter } from "effect/Record"
  *
  * const x = { a: 1, b: 2, c: 3, d: 4 }
  * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1081,10 +1173,12 @@ export const 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 { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
    * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1099,10 +1193,12 @@ export const 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 { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
    * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1117,10 +1213,12 @@ export const 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 { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
    * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1136,10 +1234,12 @@ export const 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 { filter } from "effect/Record"
    *
    * const x = { a: 1, b: 2, c: 3, d: 4 }
    * assert.deepStrictEqual(filter(x, (n) => n > 2), { c: 3, d: 4 })
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1170,12 +1270,14 @@ export const filter: {
  * @param self - A record with `Option` values.
  *
  * @example
+ * ```ts
  * import { Record, Option } from "effect"
  *
  * assert.deepStrictEqual(
  *   Record.getSomes({ a: Option.some(1), b: Option.none(), c: Option.some(2) }),
  *   { a: 1, c: 2 }
  * )
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1190,12 +1292,14 @@ export const getSomes: <K extends string, A>(
  * Given a record with `Either` values, returns a new record containing only the `Left` values, preserving the original keys.
  *
  * @example
+ * ```ts
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
  *   Record.getLefts({ a: Either.right(1), b: Either.left("err"), c: Either.right(2) }),
  *   { b: "err" }
  * )
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1218,12 +1322,14 @@ export const getLefts = <K extends string, R, L>(
  * Given a record with `Either` values, returns a new record containing only the `Right` values, preserving the original keys.
  *
  * @example
+ * ```ts
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
  *   Record.getRights({ a: Either.right(1), b: Either.left("err"), c: Either.right(2) }),
  *   { a: 1, c: 2 }
  * )
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1249,11 +1355,13 @@ export const getRights = <K extends string, R, L>(
  * @param f - The predicate function to apply to each element.
  *
  * @example
+ * ```ts
  * import { Record, Either } from "effect"
  *
  * const x = { a: 1, b: 2, c: 3 }
  * const f = (n: number) => (n % 2 === 0 ? Either.right(n) : Either.left(n))
  * assert.deepStrictEqual(Record.partitionMap(x, f), [{ a: 1, c: 3 }, { b: 2}])
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1266,11 +1374,13 @@ export const partitionMap: {
    * @param f - The predicate function to apply to each element.
    *
    * @example
+   * ```ts
    * import { Record, Either } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * const f = (n: number) => (n % 2 === 0 ? Either.right(n) : Either.left(n))
    * assert.deepStrictEqual(Record.partitionMap(x, f), [{ a: 1, c: 3 }, { b: 2}])
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1285,11 +1395,13 @@ export const partitionMap: {
    * @param f - The predicate function to apply to each element.
    *
    * @example
+   * ```ts
    * import { Record, Either } from "effect"
    *
    * const x = { a: 1, b: 2, c: 3 }
    * const f = (n: number) => (n % 2 === 0 ? Either.right(n) : Either.left(n))
    * assert.deepStrictEqual(Record.partitionMap(x, f), [{ a: 1, c: 3 }, { b: 2}])
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1325,12 +1437,14 @@ export const partitionMap: {
  * @param self - the record to partition.
  *
  * @example
+ * ```ts
  * import { Record, Either } from "effect"
  *
  * assert.deepStrictEqual(
  *   Record.separate({ a: Either.left("e"), b: Either.right(1) }),
  *   [{ a: "e" }, { b: 1 }]
  * )
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1346,12 +1460,14 @@ export const separate: <K extends string, A, B>(
  * @param predicate - The partitioning function to determine the partitioning of each value of the record.
  *
  * @example
+ * ```ts
  * import { partition } from "effect/Record"
  *
  * assert.deepStrictEqual(
  *   partition({ a: 1, b: 3 }, (n) => n > 2),
  *   [{ a: 1 }, { b: 3 }]
  * )
+ * ```
  *
  * @category filtering
  * @since 2.0.0
@@ -1364,12 +1480,14 @@ export const partition: {
    * @param predicate - The partitioning function to determine the partitioning of each value of the record.
    *
    * @example
+   * ```ts
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
    *   partition({ a: 1, b: 3 }, (n) => n > 2),
    *   [{ a: 1 }, { b: 3 }]
    * )
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1387,12 +1505,14 @@ export const partition: {
    * @param predicate - The partitioning function to determine the partitioning of each value of the record.
    *
    * @example
+   * ```ts
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
    *   partition({ a: 1, b: 3 }, (n) => n > 2),
    *   [{ a: 1 }, { b: 3 }]
    * )
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1407,12 +1527,14 @@ export const partition: {
    * @param predicate - The partitioning function to determine the partitioning of each value of the record.
    *
    * @example
+   * ```ts
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
    *   partition({ a: 1, b: 3 }, (n) => n > 2),
    *   [{ a: 1 }, { b: 3 }]
    * )
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1428,12 +1550,14 @@ export const partition: {
    * @param predicate - The partitioning function to determine the partitioning of each value of the record.
    *
    * @example
+   * ```ts
    * import { partition } from "effect/Record"
    *
    * assert.deepStrictEqual(
    *   partition({ a: 1, b: 3 }, (n) => n > 2),
    *   [{ a: 1 }, { b: 3 }]
    * )
+   * ```
    *
    * @category filtering
    * @since 2.0.0
@@ -1488,10 +1612,12 @@ export const values = <K extends string, A>(self: ReadonlyRecord<K, A>): Array<A
  * @param values - The value you want to associate with the key.
  *
  * @example
+ * ```ts
  * import { set } from "effect/Record"
  *
  * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
  * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 });
+ * ```
  *
  * @since 2.0.0
  */
@@ -1504,10 +1630,12 @@ export const set: {
    * @param values - The value you want to associate with the key.
    *
    * @example
+   * ```ts
    * import { set } from "effect/Record"
    *
    * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
    * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 });
+   * ```
    *
    * @since 2.0.0
    */
@@ -1523,10 +1651,12 @@ export const set: {
    * @param values - The value you want to associate with the key.
    *
    * @example
+   * ```ts
    * import { set } from "effect/Record"
    *
    * assert.deepStrictEqual(set("a", 5)({ a: 1, b: 2 }), { a: 5, b: 2 });
    * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 });
+   * ```
    *
    * @since 2.0.0
    */
@@ -1555,10 +1685,12 @@ export const set: {
  * @param value - The new value to associate with the key.
  *
  * @example
+ * ```ts
  * import { Record } from "effect"
  *
  * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
  * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 });
+ * ```
  *
  * @since 2.0.0
  */
@@ -1572,10 +1704,12 @@ export const replace: {
    * @param value - The new value to associate with the key.
    *
    * @example
+   * ```ts
    * import { Record } from "effect"
    *
    * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
    * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 });
+   * ```
    *
    * @since 2.0.0
    */
@@ -1589,10 +1723,12 @@ export const replace: {
    * @param value - The new value to associate with the key.
    *
    * @example
+   * ```ts
    * import { Record } from "effect"
    *
    * assert.deepStrictEqual(Record.replace("a", 3)({ a: 1, b: 2 }), { a: 3, b: 2 });
    * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 });
+   * ```
    *
    * @since 2.0.0
    */