Interface HashableEqualityComparer<T>

Provides methods to compare the equality of two objects, along with a function to hash the objects for hash map implementation.

Remarks

Due to the limitation of current JavaScript API, there is no efficient approach to evaluate hash code for every primitive types (e.g. string). This can cause significant performance penalty.

See

EqualityComparer

interface HashableEqualityComparer<T = any> {
    equals(x: T, y: T): boolean;
    getHashCode(value: T): number;
    isSupported(value: unknown): value is T;
}

Type Parameters

T = any

Hierarchy (View Summary)

EqualityComparer<T>
- HashableEqualityComparer

Implemented by

Index

Methods

equals getHashCode isSupported

Methods

equals

equals(x: T, y: T): boolean
Compares the equality of two objects.
Parameters
- x: T
- y: T
Returns boolean
- true if x is equal to y.
- false if x is not equal to y.
Overrides EqualityComparer.equals
- Defined in packages/jscorlib/src/collections/equalityComparison/typing.ts:47

getHashCode

getHashCode(value: T): number
Evaluates the hash code for the specified value.
Parameters
- value: T
Returns number

Remarks
Implementations are required to ensure that if equals returns true for two values x and y, then the value returned by getHashCode for x must equal the value returned for y.
- Defined in packages/jscorlib/src/collections/equalityComparison/typing.ts:54

isSupported

isSupported(value: unknown): value is T
Given an aribtrary value, checks whether the value can be compared by the current HashableEqualityComparer.
Parameters
- value: unknown
Returns value is T
Overrides EqualityComparer.isSupported
- Defined in packages/jscorlib/src/collections/equalityComparison/typing.ts:58

Interface HashableEqualityComparer<T>

Remarks

See

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Methods

Methods

equals

Parameters

Returns boolean

getHashCode

Parameters

Returns number

Remarks

isSupported

Parameters

Returns value is T

Settings

On This Page