effect 3.10.18 → 3.11.0

package/dist/dts/Record.d.ts

@@ -51,10 +51,12 @@ export declare const empty: <K extends string | symbol = never, V = never>() =>
  * @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
@@ -66,10 +68,12 @@ export declare const isEmptyRecord: <K extends string, A>(self: Record<K, A>) =>
  * @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
@@ -83,6 +87,7 @@ export declare const isEmptyReadonlyRecord: <K extends string, A>(self: Readonly
  * @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]
@@ -91,6 +96,7 @@ export declare const isEmptyReadonlyRecord: <K extends string, A>(self: Readonly
  *   fromIterableWith(input, a => [String(a), a * 2]),
  *   { '1': 2, '2': 4, '3': 6, '4': 8 }
  * )
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -104,6 +110,7 @@ export declare 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]
@@ -112,6 +119,7 @@ export declare const fromIterableWith: {
      *   fromIterableWith(input, a => [String(a), a * 2]),
      *   { '1': 2, '2': 4, '3': 6, '4': 8 }
      * )
+     * ```
      *
      * @category constructors
      * @since 2.0.0
@@ -125,6 +133,7 @@ export declare 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]
@@ -133,6 +142,7 @@ export declare const fromIterableWith: {
      *   fromIterableWith(input, a => [String(a), a * 2]),
      *   { '1': 2, '2': 4, '3': 6, '4': 8 }
      * )
+     * ```
      *
      * @category constructors
      * @since 2.0.0
@@ -146,6 +156,7 @@ export declare const fromIterableWith: {
  * @param f - A function that extracts the key for each element.
  *
  * @example
+ * ```ts
  * import { fromIterableBy } from "effect/Record"
  *
  * const users = [
@@ -160,6 +171,7 @@ export declare const fromIterableWith: {
  *     "1": { id: "1", name: "name1" }
  *   }
  * )
+ * ```
  *
  * @category constructors
  * @since 2.0.0
@@ -174,11 +186,13 @@ export declare const fromIterableBy: <A, K extends string | symbol>(items: Itera
  * @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
@@ -191,10 +205,12 @@ export declare 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
@@ -207,10 +223,12 @@ export declare 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
@@ -223,10 +241,12 @@ export declare 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
@@ -239,10 +259,12 @@ export declare 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
@@ -254,9 +276,11 @@ export declare const toEntries: <K extends string, A>(self: ReadonlyRecord<K, A>
  * @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
  */
@@ -268,10 +292,12 @@ export declare const size: <K extends string, A>(self: ReadonlyRecord<K, A>) =>
  * @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
  */
@@ -283,10 +309,12 @@ export declare 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
      */
@@ -298,10 +326,12 @@ export declare 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
      */
@@ -314,12 +344,14 @@ export declare 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
  */
@@ -331,12 +363,14 @@ export declare 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
      */
@@ -348,12 +382,14 @@ export declare 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
      */
@@ -368,6 +404,7 @@ export declare 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
@@ -380,6 +417,7 @@ export declare const get: {
  *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
  *  { a: 3 }
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -393,6 +431,7 @@ export declare 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
@@ -405,6 +444,7 @@ export declare const modify: {
      *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
      *  { a: 3 }
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -418,6 +458,7 @@ export declare 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
@@ -430,6 +471,7 @@ export declare const modify: {
      *  R.modify({ a: 3 } as Record<string, number>, 'b', f),
      *  { a: 3 }
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -444,6 +486,7 @@ export declare 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
@@ -456,6 +499,7 @@ export declare const modify: {
  *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
  *  Option.none()
  * )
+ * ```
  *
  * @since 2.0.0
  */
@@ -469,6 +513,7 @@ export declare 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
@@ -481,6 +526,7 @@ export declare const modifyOption: {
      *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
      *  Option.none()
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -494,6 +540,7 @@ export declare 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
@@ -506,6 +553,7 @@ export declare const modifyOption: {
      *  R.modifyOption({ a: 3 } as Record<string, number>, 'b', f),
      *  Option.none()
      * )
+     * ```
      *
      * @since 2.0.0
      */
@@ -519,6 +567,7 @@ export declare const modifyOption: {
  * @param b - The new value to replace the existing value with.
  *
  * @example
+ * ```ts
  * import { Record, Option } from "effect"
  *
  * assert.deepStrictEqual(
@@ -526,6 +575,7 @@ export declare 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
  */
@@ -538,6 +588,7 @@ export declare const replaceOption: {
      * @param b - The new value to replace the existing value with.
      *
      * @example
+     * ```ts
      * import { Record, Option } from "effect"
      *
      * assert.deepStrictEqual(
@@ -545,6 +596,7 @@ export declare 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
      */
@@ -557,6 +609,7 @@ export declare const replaceOption: {
      * @param b - The new value to replace the existing value with.
      *
      * @example
+     * ```ts
      * import { Record, Option } from "effect"
      *
      * assert.deepStrictEqual(
@@ -564,6 +617,7 @@ export declare 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
      */
@@ -577,9 +631,11 @@ export declare 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
  */
@@ -592,9 +648,11 @@ export declare 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
      */
@@ -607,9 +665,11 @@ export declare 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
      */
@@ -624,10 +684,12 @@ export declare 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
@@ -642,10 +704,12 @@ export declare 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
@@ -660,10 +724,12 @@ export declare 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
@@ -677,6 +743,7 @@ export declare 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}`
@@ -686,6 +753,7 @@ export declare 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
@@ -698,6 +766,7 @@ export declare 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}`
@@ -707,6 +776,7 @@ export declare 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
@@ -719,6 +789,7 @@ export declare 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}`
@@ -728,6 +799,7 @@ export declare 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
@@ -738,9 +810,11 @@ export declare 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
@@ -750,9 +824,11 @@ export declare 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
@@ -762,9 +838,11 @@ export declare 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
@@ -775,9 +853,11 @@ export declare 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
@@ -787,9 +867,11 @@ export declare 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
@@ -799,9 +881,11 @@ export declare 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
@@ -816,11 +900,13 @@ export declare 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
  */
@@ -833,11 +919,13 @@ export declare 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
      */
@@ -850,11 +938,13 @@ export declare 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
      */
@@ -867,10 +957,12 @@ export declare 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
@@ -883,10 +975,12 @@ export declare 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
@@ -899,10 +993,12 @@ export declare 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
@@ -915,10 +1011,12 @@ export declare 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
@@ -931,10 +1029,12 @@ export declare 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
@@ -947,12 +1047,14 @@ export declare 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
@@ -962,12 +1064,14 @@ export declare const getSomes: <K extends string, A>(self: ReadonlyRecord<K, Opt
  * 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
@@ -977,12 +1081,14 @@ export declare const getLefts: <K extends string, R, L>(self: ReadonlyRecord<K,
  * 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
@@ -995,11 +1101,13 @@ export declare const getRights: <K extends string, R, L>(self: ReadonlyRecord<K,
  * @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
@@ -1012,11 +1120,13 @@ export declare 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
@@ -1029,11 +1139,13 @@ export declare 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
@@ -1047,12 +1159,14 @@ export declare 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
@@ -1065,12 +1179,14 @@ export declare const separate: <K extends string, A, B>(self: ReadonlyRecord<K,
  * @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
@@ -1083,12 +1199,14 @@ export declare 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
@@ -1104,12 +1222,14 @@ export declare 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
@@ -1122,12 +1242,14 @@ export declare 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
@@ -1143,12 +1265,14 @@ export declare 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
@@ -1179,10 +1303,12 @@ export declare const values: <K extends string, A>(self: ReadonlyRecord<K, 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
  */
@@ -1195,10 +1321,12 @@ export declare 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
      */
@@ -1211,10 +1339,12 @@ export declare 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
      */
@@ -1229,10 +1359,12 @@ export declare 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
  */
@@ -1246,10 +1378,12 @@ export declare 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
      */
@@ -1263,10 +1397,12 @@ export declare 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
      */