StructuralEquatable Interface

Package: @esfx/equatable

Represents a value that can compare its structural equality with another value.

Declaration

export interface StructuralEquatable 

Methods

[StructuralEquatable.structuralEquals](other, equaler)

Determines whether this value is structurally equal to another value using the supplied Equaler.

Declaration

[StructuralEquatable.structuralEquals](other: unknown, equaler: Equaler<unknown>): boolean;

Parameters

other

unknown

The other value.

equaler

Equaler<unknown>

The Equaler to use to test equality.

Returns

boolean

true if this value is structurally equal to other; otherwise, false.

[StructuralEquatable.structuralHash](equaler)

Compute a structural hash code for a value using the supplied Equaler.

Declaration

[StructuralEquatable.structuralHash](equaler: Equaler<unknown>): number;

Parameters

equaler

Equaler<unknown>

The Equaler to use to generate hashes for values in the structure.

Returns

number

The numeric hash-code of the structure.