Equality

Equality: object

Defined in: Core/Equality.ts:14

Type Declaration

and

and: <A>(eq2) => (eq1) => Equality<A>

Combines two equalities with logical AND. Both must pass for two values to be considered equal. Data-last: the first equality is the data being piped.

Type Parameters

A

A

Parameters

eq2

Equality<A>

Returns

(eq1) => Equality<A>

Example

const exact = pipe(byName, Equality.and(byRole));
exact(userA, userB); // true only if name AND role match

array

array: <A>(eq) => Equality<readonly A[]>

Lifts an element equality into an array equality. Two arrays are equal if they have the same length and every element pair is equal under eq.

Type Parameters

A

A

Parameters

eq

Equality<A>

Returns

Equality<readonly A[]>

Example

Equality.array(Equality.number)([1, 2, 3], [1, 2, 3]); // true

boolean

boolean: Equality<boolean> = booleanEq

Equality for booleans.

Example

Equality.boolean(true, true); // true

by

by: <A, B>(f) => (eq) => Equality<B>

Adapts an equality for type A into an equality for type B by extracting a field. Read as “equality by this field”: pipe(Equality.string, Equality.by(u => u.name)).

Type Parameters

A

A

B

B

Parameters

f

(b) => A

Returns

(eq) => Equality<B>

Example

type Product = { id: string; price: number };
const byId = pipe(Equality.string, Equality.by((p: Product) => p.id));
byId({ id: "p1", price: 9 }, { id: "p1", price: 12 }); // true

date

date: Equality<Date> = dateEq

Equality for Date values. Compares by numeric time value.

Example

Equality.date(new Date("2024-01-01"), new Date("2024-01-01")); // true

number

number: Equality<number> = numberEq

Equality for numbers. Uses strict equality.

Example

Equality.number(42, 42); // true

string

string: Equality<string> = stringEq

Equality for strings. Case-sensitive.

Example

Equality.string("hello", "hello"); // true
Equality.string("hello", "Hello"); // false

struct

struct: <R>(fields) => Equality<R>

Derives deep equality for a record from field-level Equality checkers.

Type Parameters

R

R extends Record<string, unknown>

Parameters

fields

{ [K in string | number | symbol]: Equality<R[K]> }

Returns

Equality<R>

Example

const userEq = Equality.struct({
  id: Equality.string,
  age: Equality.number,
});

tuple

tuple: <T>(…equalities) => Equality<T>

Derives element-wise equality for a tuple from positional Equality checkers.

Type Parameters

T

T extends readonly unknown[]

Parameters

equalities

…{ [K in string | number | symbol]: Equality<T[K]> }

Returns

Equality<T>

Example

const pairEq = Equality.tuple(Equality.string, Equality.number);
pairEq(["a", 1], ["a", 1]); // true