/** * This module provides utility functions for working with records in TypeScript. * * @since 2.0.0 */ import type { Either } from "./Either.js"; import type { Equivalence } from "./Equivalence.js"; import type { TypeLambda } from "./HKT.js"; import * as Option from "./Option.js"; import type { NoInfer } from "./Types.js"; /** * @category models * @since 2.0.0 */ export type ReadonlyRecord = { readonly [P in K]: A; }; /** * @since 2.0.0 */ export declare namespace ReadonlyRecord { type IsFiniteString = T extends "" ? true : [ T ] extends [`${infer Head}${infer Rest}`] ? string extends Head ? false : `${number}` extends Head ? false : Rest extends "" ? true : IsFiniteString : false; /** * @since 2.0.0 */ type NonLiteralKey = K extends string ? IsFiniteString extends true ? string : K : symbol; /** * @since 2.0.0 */ type IntersectKeys = [string] extends [K1 | K2] ? NonLiteralKey & NonLiteralKey : K1 & K2; } /** * @category type lambdas * @since 2.0.0 */ export interface ReadonlyRecordTypeLambda extends TypeLambda { readonly type: ReadonlyRecord; } /** * Creates a new, empty record. * * @category constructors * @since 2.0.0 */ export declare const empty: () => Record, V>; /** * Determine if a record is empty. * * @example * ```ts * import * as assert from "node:assert" * import { isEmptyRecord } from "effect/Record" * * assert.deepStrictEqual(isEmptyRecord({}), true); * assert.deepStrictEqual(isEmptyRecord({ a: 3 }), false); * ``` * * @category guards * @since 2.0.0 */ export declare const isEmptyRecord: (self: Record) => self is Record; /** * Determine if a record is empty. * * @example * ```ts * import * as assert from "node:assert" * import { isEmptyReadonlyRecord } from "effect/Record" * * assert.deepStrictEqual(isEmptyReadonlyRecord({}), true); * assert.deepStrictEqual(isEmptyReadonlyRecord({ a: 3 }), false); * ``` * * @category guards * @since 2.0.0 */ export declare const isEmptyReadonlyRecord: (self: ReadonlyRecord) => self is ReadonlyRecord; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * import { fromIterableWith } from "effect/Record" * * const input = [1, 2, 3, 4] * * assert.deepStrictEqual( * fromIterableWith(input, a => [String(a), a * 2]), * { '1': 2, '2': 4, '3': 6, '4': 8 } * ) * ``` * * @category constructors * @since 2.0.0 */ export declare 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. * * @example * ```ts * import * as assert from "node:assert" * import { fromIterableWith } from "effect/Record" * * const input = [1, 2, 3, 4] * * assert.deepStrictEqual( * fromIterableWith(input, a => [String(a), a * 2]), * { '1': 2, '2': 4, '3': 6, '4': 8 } * ) * ``` * * @category constructors * @since 2.0.0 */ (f: (a: A) => readonly [K, B]): (self: Iterable) => Record, B>; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * import { fromIterableWith } from "effect/Record" * * const input = [1, 2, 3, 4] * * assert.deepStrictEqual( * fromIterableWith(input, a => [String(a), a * 2]), * { '1': 2, '2': 4, '3': 6, '4': 8 } * ) * ``` * * @category constructors * @since 2.0.0 */ (self: Iterable, f: (a: A) => readonly [K, B]): Record, B>; }; /** * Creates a new record from an iterable, utilizing the provided function to determine the key for each element. * * @example * ```ts * import * as assert from "node:assert" * import { fromIterableBy } from "effect/Record" * * const users = [ * { id: "2", name: "name2" }, * { id: "1", name: "name1" } * ] * * assert.deepStrictEqual( * fromIterableBy(users, user => user.id), * { * "2": { id: "2", name: "name2" }, * "1": { id: "1", name: "name1" } * } * ) * ``` * * @category constructors * @since 2.0.0 */ export declare const fromIterableBy: (items: Iterable, f: (a: A) => K) => Record, A>; /** * Builds a record from an iterable of key-value pairs. * * 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. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const fromEntries: (entries: Iterable) => Record, Entry[1]>; /** * Transforms the values of a record into an `Array` with a custom mapping function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const collect: { /** * Transforms the values of a record into an `Array` with a custom mapping function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (f: (key: K, a: A) => B): (self: ReadonlyRecord) => Array; /** * Transforms the values of a record into an `Array` with a custom mapping function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, f: (key: K, a: A) => B): Array; }; /** * Takes a record and returns an array of tuples containing its keys and values. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const toEntries: (self: ReadonlyRecord) => Array<[K, A]>; /** * Returns the number of key/value pairs in a record. * * @example * ```ts * import * as assert from "node:assert" * import { size } from "effect/Record"; * * assert.deepStrictEqual(size({ a: "a", b: 1, c: true }), 3); * ``` * * @since 2.0.0 */ export declare const size: (self: ReadonlyRecord) => number; /** * Check if a given `key` exists in a record. * * @example * ```ts * import * as assert from "node:assert" * import { empty, has } from "effect/Record" * * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true); * assert.deepStrictEqual(has(empty(), "c"), false); * ``` * * @since 2.0.0 */ export declare const has: { /** * Check if a given `key` exists in a record. * * @example * ```ts * import * as assert from "node:assert" * import { empty, has } from "effect/Record" * * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true); * assert.deepStrictEqual(has(empty(), "c"), false); * ``` * * @since 2.0.0 */ (key: NoInfer): (self: ReadonlyRecord) => boolean; /** * Check if a given `key` exists in a record. * * @example * ```ts * import * as assert from "node:assert" * import { empty, has } from "effect/Record" * * assert.deepStrictEqual(has({ a: 1, b: 2 }, "a"), true); * assert.deepStrictEqual(has(empty(), "c"), false); * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: NoInfer): boolean; }; /** * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const person: Record = { 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 */ export declare const get: { /** * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const person: Record = { 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 */ (key: NoInfer): (self: ReadonlyRecord) => Option.Option; /** * Retrieve a value at a particular key from a record, returning it wrapped in an `Option`. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const person: Record = { 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 */ (self: ReadonlyRecord, key: NoInfer): Option.Option; }; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modify({ a: 3 }, 'a', f), * { a: 6 } * ) * assert.deepStrictEqual( * R.modify({ a: 3 } as Record, 'b', f), * { a: 3 } * ) * ``` * * @since 2.0.0 */ export declare 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. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modify({ a: 3 }, 'a', f), * { a: 6 } * ) * assert.deepStrictEqual( * R.modify({ a: 3 } as Record, 'b', f), * { a: 3 } * ) * ``` * * @since 2.0.0 */ (key: NoInfer, f: (a: A) => B): (self: ReadonlyRecord) => Record; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modify({ a: 3 }, 'a', f), * { a: 6 } * ) * assert.deepStrictEqual( * R.modify({ a: 3 } as Record, 'b', f), * { a: 3 } * ) * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: NoInfer, f: (a: A) => B): Record; }; /** * Apply a function to the element at the specified key, creating a new record, * or return `None` if the key doesn't exist. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modifyOption({ a: 3 }, 'a', f), * Option.some({ a: 6 }) * ) * assert.deepStrictEqual( * R.modifyOption({ a: 3 } as Record, 'b', f), * Option.none() * ) * ``` * * @since 2.0.0 */ export declare 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. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modifyOption({ a: 3 }, 'a', f), * Option.some({ a: 6 }) * ) * assert.deepStrictEqual( * R.modifyOption({ a: 3 } as Record, 'b', f), * Option.none() * ) * ``` * * @since 2.0.0 */ (key: NoInfer, f: (a: A) => B): (self: ReadonlyRecord) => Option.Option>; /** * Apply a function to the element at the specified key, creating a new record, * or return `None` if the key doesn't exist. * * @example * ```ts * import * as assert from "node:assert" * import { Record as R, Option } from "effect" * * const f = (x: number) => x * 2 * * assert.deepStrictEqual( * R.modifyOption({ a: 3 }, 'a', f), * Option.some({ a: 6 }) * ) * assert.deepStrictEqual( * R.modifyOption({ a: 3 } as Record, 'b', f), * Option.none() * ) * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: NoInfer, f: (a: A) => B): Option.Option>; }; /** * Replaces a value in the record with the new value passed as parameter. * * @example * ```ts * import * as assert from "node:assert" * import { Record, Option } from "effect" * * assert.deepStrictEqual( * Record.replaceOption({ a: 1, b: 2, c: 3 }, 'a', 10), * Option.some({ a: 10, b: 2, c: 3 }) * ) * assert.deepStrictEqual(Record.replaceOption(Record.empty(), 'a', 10), Option.none()) * ``` * * @since 2.0.0 */ export declare const replaceOption: { /** * Replaces a value in the record with the new value passed as parameter. * * @example * ```ts * import * as assert from "node:assert" * import { Record, Option } from "effect" * * assert.deepStrictEqual( * Record.replaceOption({ a: 1, b: 2, c: 3 }, 'a', 10), * Option.some({ a: 10, b: 2, c: 3 }) * ) * assert.deepStrictEqual(Record.replaceOption(Record.empty(), 'a', 10), Option.none()) * ``` * * @since 2.0.0 */ (key: NoInfer, b: B): (self: ReadonlyRecord) => Option.Option>; /** * Replaces a value in the record with the new value passed as parameter. * * @example * ```ts * import * as assert from "node:assert" * import { Record, Option } from "effect" * * assert.deepStrictEqual( * Record.replaceOption({ a: 1, b: 2, c: 3 }, 'a', 10), * Option.some({ a: 10, b: 2, c: 3 }) * ) * assert.deepStrictEqual(Record.replaceOption(Record.empty(), 'a', 10), Option.none()) * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: NoInfer, b: B): Option.Option>; }; /** * If the given key exists in the record, returns a new record with the key removed, * otherwise returns a copy of the original record. * * @example * ```ts * import * as assert from "node:assert" * import { remove } from "effect/Record" * * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 }) * ``` * * @since 2.0.0 */ export declare 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. * * @example * ```ts * import * as assert from "node:assert" * import { remove } from "effect/Record" * * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 }) * ``` * * @since 2.0.0 */ (key: X): (self: ReadonlyRecord) => Record, A>; /** * If the given key exists in the record, returns a new record with the key removed, * otherwise returns a copy of the original record. * * @example * ```ts * import * as assert from "node:assert" * import { remove } from "effect/Record" * * assert.deepStrictEqual(remove({ a: 1, b: 2 }, "a"), { b: 2 }) * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: X): Record, A>; }; /** * Retrieves the value of the property with the given `key` from a record and returns an `Option` * of a tuple with the value and the record with the removed property. * If the key is not present, returns `O.none`. * * @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 }])) * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record, "c"), Option.none()) * ``` * * @category record * @since 2.0.0 */ export declare const pop: { /** * Retrieves the value of the property with the given `key` from a record and returns an `Option` * of a tuple with the value and the record with the removed property. * If the key is not present, returns `O.none`. * * @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 }])) * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record, "c"), Option.none()) * ``` * * @category record * @since 2.0.0 */ (key: X): (self: ReadonlyRecord) => Option.Option<[A, Record, A>]>; /** * Retrieves the value of the property with the given `key` from a record and returns an `Option` * of a tuple with the value and the record with the removed property. * If the key is not present, returns `O.none`. * * @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 }])) * assert.deepStrictEqual(R.pop({ a: 1, b: 2 } as Record, "c"), Option.none()) * ``` * * @category record * @since 2.0.0 */ (self: ReadonlyRecord, key: X): Option.Option<[A, Record, A>]>; }; /** * Maps a record into another record by applying a transformation function to each of its values. * * @example * ```ts * import * as assert from "node:assert" * import { map } from "effect/Record" * * const f = (n: number) => `-${n}` * * assert.deepStrictEqual(map({ a: 3, b: 5 }, f), { a: "-3", b: "-5" }) * * 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 */ export declare const map: { /** * Maps a record into another record by applying a transformation function to each of its values. * * @example * ```ts * import * as assert from "node:assert" * import { map } from "effect/Record" * * const f = (n: number) => `-${n}` * * assert.deepStrictEqual(map({ a: 3, b: 5 }, f), { a: "-3", b: "-5" }) * * 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 */ (f: (a: A, key: NoInfer) => B): (self: ReadonlyRecord) => Record; /** * Maps a record into another record by applying a transformation function to each of its values. * * @example * ```ts * import * as assert from "node:assert" * import { map } from "effect/Record" * * const f = (n: number) => `-${n}` * * assert.deepStrictEqual(map({ a: 3, b: 5 }, f), { a: "-3", b: "-5" }) * * 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 */ (self: ReadonlyRecord, f: (a: A, key: NoInfer) => B): Record; }; /** * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ export declare const mapKeys: { /** * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ (f: (key: K, a: A) => K2): (self: ReadonlyRecord) => Record; /** * Maps the keys of a `ReadonlyRecord` while preserving the corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ (self: ReadonlyRecord, f: (key: K, a: A) => K2): Record; }; /** * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ export declare const mapEntries: { /** * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ (f: (a: A, key: K) => readonly [K2, B]): (self: ReadonlyRecord) => Record; /** * Maps entries of a `ReadonlyRecord` using the provided function, allowing modification of both keys and corresponding values. * * @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 }) * ``` * * @category mapping * @since 2.0.0 */ (self: ReadonlyRecord, f: (a: A, key: K) => [K2, B]): Record; }; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare 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. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (f: (a: A, key: K) => Option.Option): (self: ReadonlyRecord) => Record, B>; /** * 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. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, f: (a: A, key: K) => Option.Option): Record, B>; }; /** * Selects properties from a record whose values match the given predicate. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const filter: { /** * Selects properties from a record whose values match the given predicate. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (refinement: (a: NoInfer, key: K) => a is B): (self: ReadonlyRecord) => Record, B>; /** * Selects properties from a record whose values match the given predicate. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (predicate: (A: NoInfer, key: K) => boolean): (self: ReadonlyRecord) => Record, A>; /** * Selects properties from a record whose values match the given predicate. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, refinement: (a: A, key: K) => a is B): Record, B>; /** * Selects properties from a record whose values match the given predicate. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, predicate: (a: A, key: K) => boolean): Record, A>; }; /** * Given a record with `Option` values, returns a new record containing only the `Some` values, preserving the original keys. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const getSomes: (self: ReadonlyRecord>) => Record, A>; /** * Given a record with `Either` values, returns a new record containing only the `Left` values, preserving the original keys. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const getLefts: (self: ReadonlyRecord>) => Record, L>; /** * Given a record with `Either` values, returns a new record containing only the `Right` values, preserving the original keys. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const getRights: (self: ReadonlyRecord>) => Record; /** * Partitions the elements of a record into two groups: those that match a predicate, and those that don't. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const partitionMap: { /** * Partitions the elements of a record into two groups: those that match a predicate, and those that don't. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (f: (a: A, key: K) => Either): (self: ReadonlyRecord) => [left: Record, B>, right: Record, C>]; /** * Partitions the elements of a record into two groups: those that match a predicate, and those that don't. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, f: (a: A, key: K) => Either): [left: Record, B>, right: Record, C>]; }; /** * Partitions a record of `Either` values into two separate records, * one with the `Left` values and one with the `Right` values. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const separate: (self: ReadonlyRecord>) => [Record, A>, Record, B>]; /** * Partitions a record into two separate records based on the result of a predicate function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ export declare const partition: { /** * Partitions a record into two separate records based on the result of a predicate function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (refinement: (a: NoInfer, key: K) => a is B): (self: ReadonlyRecord) => [ excluded: Record, Exclude>, satisfying: Record, B> ]; /** * Partitions a record into two separate records based on the result of a predicate function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (predicate: (a: NoInfer, key: K) => boolean): (self: ReadonlyRecord) => [excluded: Record, A>, satisfying: Record, A>]; /** * Partitions a record into two separate records based on the result of a predicate function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, refinement: (a: A, key: K) => a is B): [ excluded: Record, Exclude>, satisfying: Record, B> ]; /** * Partitions a record into two separate records based on the result of a predicate function. * * @example * ```ts * import * as assert from "node:assert" * 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 */ (self: ReadonlyRecord, predicate: (a: A, key: K) => boolean): [excluded: Record, A>, satisfying: Record, A>]; }; /** * Retrieve the keys of a given record as an array. * * @since 2.0.0 */ export declare const keys: (self: ReadonlyRecord) => Array; /** * Retrieve the values of a given record as an array. * * @since 2.0.0 */ export declare const values: (self: ReadonlyRecord) => Array; /** * Add a new key-value pair or update an existing key's value in a record. * * @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 }); * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 }); * ``` * * @since 2.0.0 */ export declare const set: { /** * Add a new key-value pair or update an existing key's value in a record. * * @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 }); * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 }); * ``` * * @since 2.0.0 */ (key: K1, value: B): (self: ReadonlyRecord) => Record; /** * Add a new key-value pair or update an existing key's value in a record. * * @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 }); * assert.deepStrictEqual(set("c", 5)({ a: 1, b: 2 }), { a: 1, b: 2, c: 5 }); * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: K1, value: B): Record; }; /** * 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. * * @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 }); * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 }); * ``` * * @since 2.0.0 */ export declare 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. * * @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 }); * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 }); * ``` * * @since 2.0.0 */ (key: NoInfer, value: B): (self: ReadonlyRecord) => Record; /** * 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. * * @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 }); * assert.deepStrictEqual(Record.replace("c", 3)({ a: 1, b: 2 }), { a: 1, b: 2 }); * ``` * * @since 2.0.0 */ (self: ReadonlyRecord, key: NoInfer, value: B): Record; }; /** * Check if all the keys and values in one record are also found in another record. * * @since 2.0.0 */ export declare const isSubrecordBy: (equivalence: Equivalence) => { (that: ReadonlyRecord): (self: ReadonlyRecord) => boolean; (self: ReadonlyRecord, that: ReadonlyRecord): boolean; }; /** * 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()`). * * @since 2.0.0 */ export declare 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()`). * * @since 2.0.0 */ (that: ReadonlyRecord): (self: ReadonlyRecord) => boolean; /** * 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()`). * * @since 2.0.0 */ (self: ReadonlyRecord, that: ReadonlyRecord): boolean; }; /** * Reduce a record to a single value by combining its entries with a specified function. * * @category folding * @since 2.0.0 */ export declare const reduce: { /** * Reduce a record to a single value by combining its entries with a specified function. * * @category folding * @since 2.0.0 */ (zero: Z, f: (accumulator: Z, value: V, key: K) => Z): (self: ReadonlyRecord) => Z; /** * Reduce a record to a single value by combining its entries with a specified function. * * @category folding * @since 2.0.0 */ (self: ReadonlyRecord, zero: Z, f: (accumulator: Z, value: V, key: K) => Z): Z; }; /** * Check if all entries in a record meet a specific condition. * * @since 2.0.0 */ export declare const every: { /** * Check if all entries in a record meet a specific condition. * * @since 2.0.0 */ (refinement: (value: A, key: K) => value is B): (self: ReadonlyRecord) => self is ReadonlyRecord; /** * Check if all entries in a record meet a specific condition. * * @since 2.0.0 */ (predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord) => boolean; /** * Check if all entries in a record meet a specific condition. * * @since 2.0.0 */ (self: ReadonlyRecord, refinement: (value: A, key: K) => value is B): self is ReadonlyRecord; /** * Check if all entries in a record meet a specific condition. * * @since 2.0.0 */ (self: ReadonlyRecord, predicate: (value: A, key: K) => boolean): boolean; }; /** * Check if any entry in a record meets a specific condition. * * @since 2.0.0 */ export declare const some: { /** * Check if any entry in a record meets a specific condition. * * @since 2.0.0 */ (predicate: (value: A, key: K) => boolean): (self: ReadonlyRecord) => boolean; /** * Check if any entry in a record meets a specific condition. * * @since 2.0.0 */ (self: ReadonlyRecord, predicate: (value: A, key: K) => boolean): boolean; }; /** * Merge two records, preserving entries that exist in either of the records. * * @since 2.0.0 */ export declare const union: { /** * Merge two records, preserving entries that exist in either of the records. * * @since 2.0.0 */ (that: ReadonlyRecord, combine: (selfValue: A, thatValue: B) => C): (self: ReadonlyRecord) => Record; /** * Merge two records, preserving entries that exist in either of the records. * * @since 2.0.0 */ (self: ReadonlyRecord, that: ReadonlyRecord, combine: (selfValue: A, thatValue: B) => C): Record; }; /** * Merge two records, retaining only the entries that exist in both records. * * @since 2.0.0 */ export declare const intersection: { /** * Merge two records, retaining only the entries that exist in both records. * * @since 2.0.0 */ (that: ReadonlyRecord, combine: (selfValue: A, thatValue: B) => C): (self: ReadonlyRecord) => Record, C>; /** * Merge two records, retaining only the entries that exist in both records. * * @since 2.0.0 */ (self: ReadonlyRecord, that: ReadonlyRecord, combine: (selfValue: A, thatValue: B) => C): Record, C>; }; /** * Merge two records, preserving only the entries that are unique to each record. * * @since 2.0.0 */ export declare const difference: { /** * Merge two records, preserving only the entries that are unique to each record. * * @since 2.0.0 */ (that: ReadonlyRecord): (self: ReadonlyRecord) => Record; /** * Merge two records, preserving only the entries that are unique to each record. * * @since 2.0.0 */ (self: ReadonlyRecord, that: ReadonlyRecord): Record; }; /** * Create an `Equivalence` for records using the provided `Equivalence` for values. * * @category instances * @since 2.0.0 */ export declare const getEquivalence: (equivalence: Equivalence) => Equivalence>; /** * Create a non-empty record from a single element. * * @category constructors * @since 2.0.0 */ export declare const singleton: (key: K, value: A) => Record; /** * Returns the first entry that satisfies the specified * predicate, or `None` if no such entry exists. * * @example * ```ts * import { Record, Option } from "effect" * * const record = { a: 1, b: 2, c: 3 } * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b") * console.log(result) // Option.Some(["c", 3]) * ``` * * @category elements * @since 3.14.0 */ export declare const findFirst: { /** * Returns the first entry that satisfies the specified * predicate, or `None` if no such entry exists. * * @example * ```ts * import { Record, Option } from "effect" * * const record = { a: 1, b: 2, c: 3 } * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b") * console.log(result) // Option.Some(["c", 3]) * ``` * * @category elements * @since 3.14.0 */ (refinement: (value: NoInfer, key: NoInfer) => value is V2): (self: ReadonlyRecord) => Option.Option<[K, V2]>; /** * Returns the first entry that satisfies the specified * predicate, or `None` if no such entry exists. * * @example * ```ts * import { Record, Option } from "effect" * * const record = { a: 1, b: 2, c: 3 } * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b") * console.log(result) // Option.Some(["c", 3]) * ``` * * @category elements * @since 3.14.0 */ (predicate: (value: NoInfer, key: NoInfer) => boolean): (self: ReadonlyRecord) => Option.Option<[K, V]>; /** * Returns the first entry that satisfies the specified * predicate, or `None` if no such entry exists. * * @example * ```ts * import { Record, Option } from "effect" * * const record = { a: 1, b: 2, c: 3 } * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b") * console.log(result) // Option.Some(["c", 3]) * ``` * * @category elements * @since 3.14.0 */ (self: ReadonlyRecord, refinement: (value: NoInfer, key: NoInfer) => value is V2): Option.Option<[K, V2]>; /** * Returns the first entry that satisfies the specified * predicate, or `None` if no such entry exists. * * @example * ```ts * import { Record, Option } from "effect" * * const record = { a: 1, b: 2, c: 3 } * const result = Record.findFirst(record, (value, key) => value > 1 && key !== "b") * console.log(result) // Option.Some(["c", 3]) * ``` * * @category elements * @since 3.14.0 */ (self: ReadonlyRecord, predicate: (value: NoInfer, key: NoInfer) => boolean): Option.Option<[K, V]>; }; //# sourceMappingURL=Record.d.ts.map