Function: equalsWith()

A version of equals that allows callers to override the default comparison algorithm. If the provided override function returns a boolean, it is used as the result of the comparison. If the override returns undefined, the behavior of equalsWith defaults to that of equals.

equalsWith is curried. See curry.

Example

// `mathEquals` treats -0 as equal to 0.
const mathEquals = equalsWith({override: trueIfBothZero});

function trueIfBothZero(a: unknown, b: unknown) {
    if (a === 0 && b === 0) {
        return true;
    }
}

mathEquals({x: 0}, {x: -0}); // => true

Call Signature

equalsWith(a: EqualsOptions, b: unknown, c: unknown): boolean

Defined in: pkg/equals/src/index.ts:51

Parameters

Parameter Type
a EqualsOptions
b unknown
c unknown

Returns

boolean

Call Signature

equalsWith(a: EqualsOptions, b: unknown): Curried1<unknown, boolean>

Defined in: pkg/equals/src/index.ts:51

Parameters

Parameter Type
a EqualsOptions
b unknown

Returns

Curried1<unknown, boolean>

Call Signature

equalsWith(a: EqualsOptions): Curried2<unknown, unknown, boolean>

Defined in: pkg/equals/src/index.ts:51

Parameters

Parameter Type
a EqualsOptions

Returns

Curried2<unknown, unknown, boolean>