/** * This module provides utility functions for working with structs in TypeScript. * * @since 2.0.0 */ import * as Equivalence from "./Equivalence.js"; import { dual } from "./Function.js"; import * as order from "./Order.js"; import * as Predicate from "./Predicate.js"; /** * Create a new object by picking properties of an existing object. * * @example * ```ts * import * as assert from "node:assert" * import { pipe, Struct } from "effect" * * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.pick("a", "b")), { a: "a", b: 1 }) * assert.deepStrictEqual(Struct.pick({ a: "a", b: 1, c: true }, "a", "b"), { a: "a", b: 1 }) * ``` * * @since 2.0.0 */ export const pick = /*#__PURE__*/dual(args => Predicate.isObject(args[0]), (s, ...keys) => { const out = {}; for (const k of keys) { if (k in s) { out[k] = s[k]; } } return out; }); /** * Create a new object by omitting properties of an existing object. * * @example * ```ts * import * as assert from "node:assert" * import { pipe, Struct } from "effect" * * assert.deepStrictEqual(pipe({ a: "a", b: 1, c: true }, Struct.omit("c")), { a: "a", b: 1 }) * assert.deepStrictEqual(Struct.omit({ a: "a", b: 1, c: true }, "c"), { a: "a", b: 1 }) * ``` * * @since 2.0.0 */ export const omit = /*#__PURE__*/dual(args => Predicate.isObject(args[0]), (s, ...keys) => { const out = { ...s }; for (const k of keys) { delete out[k]; } return out; }); /** * Given a struct of `Equivalence`s returns a new `Equivalence` that compares values of a struct * by applying each `Equivalence` to the corresponding property of the struct. * * Alias of {@link Equivalence.struct}. * * @example * ```ts * import * as assert from "node:assert" * import { Struct, String, Number } from "effect" * * const PersonEquivalence = Struct.getEquivalence({ * name: String.Equivalence, * age: Number.Equivalence * }) * * assert.deepStrictEqual( * PersonEquivalence({ name: "John", age: 25 }, { name: "John", age: 25 }), * true * ) * assert.deepStrictEqual( * PersonEquivalence({ name: "John", age: 25 }, { name: "John", age: 40 }), * false * ) * ``` * * @category combinators * @since 2.0.0 */ export const getEquivalence = Equivalence.struct; /** * This function creates and returns a new `Order` for a struct of values based on the given `Order`s * for each property in the struct. * * Alias of {@link order.struct}. * * @category combinators * @since 2.0.0 */ export const getOrder = order.struct; /** * Transforms the values of a Struct provided a transformation function for each key. * If no transformation function is provided for a key, it will return the origional value for that key. * * @example * ```ts * import * as assert from "node:assert" * import { pipe, Struct } from "effect" * * assert.deepStrictEqual( * pipe( * { a: 'a', b: 1, c: 3 }, * Struct.evolve({ * a: (a) => a.length, * b: (b) => b * 2 * }) * ), * { a: 1, b: 2, c: 3 } * ) * ``` * * @since 2.0.0 */ export const evolve = /*#__PURE__*/dual(2, (obj, t) => { const out = { ...obj }; for (const k in t) { if (Object.prototype.hasOwnProperty.call(obj, k)) { // @ts-expect-error out[k] = t[k](obj[k]); } } return out; }); /** * Retrieves the value associated with the specified key from a struct. * * @example * ```ts * import * as assert from "node:assert" * import { pipe, Struct } from "effect" * * const value = pipe({ a: 1, b: 2 }, Struct.get("a")) * * assert.deepStrictEqual(value, 1) * ``` * * @since 2.0.0 */ export const get = key => s => s[key]; /** * Retrieves the object keys that are strings in a typed manner * * @example * ```ts * import * as assert from "node:assert" * import { Struct } from "effect" * * const symbol: unique symbol = Symbol() * * const value = { * a: 1, * b: 2, * [symbol]: 3 * } * * const keys: Array<"a" | "b"> = Struct.keys(value) * * assert.deepStrictEqual(keys, ["a", "b"]) * ``` * * @since 3.6.0 */ export const keys = o => Object.keys(o); //# sourceMappingURL=Struct.js.map