Utils: `equality`
Table of contents
Functions
- isDeepEqual
- isDeepEqualFP
- isEqual
- isEqualFP
- isGreaterThan
- isGreaterThanFP
- isGreaterThanOrEqualTo
- isGreaterThanOrEqualToFP
- isLessThan
- isLessThanFP
- isLessThanOrEqualTo
- isLessThanOrEqualToFP
- isSame
Functions
isDeepEqual
▸ isDeepEqual<T
>(target
, input
): input is T
Compares two values and returns a boolean if they are the same. Arrays are compared using original sorting, while object key ordering doesn't matter.
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
input is T
Example
isDeepEqual({ key1: 1, key2: 2 }, { key2: 2, key1: 1 }) === true;
isDeepEqual(null, null) === true;
isDeepEqual(undefined, undefined) === true;
isDeepEqual(NaN, NaN) === true;
isDeepEqual(3, 3) === true
isDeepEqual('hello', 'hello') === true
isDeepEqual([1, 2, 3], [1, 2, 3]) === true
isDeepEqual([{ some: 'obj' }], [{ some: 'obj' }]) === true
isDeepEqual(undefined, null) === false;
isDeepEqual([1, 2, 3], [1, 3, 2]) === false
isDeepEqual([1, 2, 3], [1, 2, undefined, 3]) === false
isDeepEqual(true, 'true') === false;
Defined in
packages/utils/src/equality.ts:45
▸ isDeepEqual<T
>(target
, input
): boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:46
isDeepEqualFP
▸ isDeepEqualFP<T
>(target
): (input
: unknown
) => input is T
A functional version of isDeepEqual
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
Returns
fn
▸ (input
): input is T
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is T
Defined in
packages/utils/src/equality.ts:69
▸ isDeepEqualFP<T
>(target
): (input
: unknown
) => boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
Returns
fn
▸ (input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:70
isEqual
▸ isEqual<T
>(target
, input
): input is T
Verify that two values are the same (uses a reference check). Similar to === except two NaNs is considered the same For deep equality use isDeepEqual
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
input is T
Defined in
packages/utils/src/equality.ts:10
▸ isEqual<T
>(target
, input
): boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:11
isEqualFP
▸ isEqualFP<T
>(target
): (input
: unknown
) => input is T
A functional version of isEqual
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
Returns
fn
▸ (input
): input is T
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is T
Defined in
packages/utils/src/equality.ts:19
▸ isEqualFP<T
>(target
): (input
: unknown
) => boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
Returns
fn
▸ (input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:20
isGreaterThan
▸ isGreaterThan(value
, other
): boolean
Check if a value is greater than another
Parameters
Name | Type |
---|---|
value | unknown |
other | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:122
isGreaterThanFP
▸ isGreaterThanFP(other
): (value
: unknown
) => boolean
Check if a value is greater than or equal to another
Parameters
Name | Type |
---|---|
other | unknown |
Returns
fn
▸ (value
): boolean
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:131
isGreaterThanOrEqualTo
▸ isGreaterThanOrEqualTo(value
, other
): boolean
Check if a value is greater than or equal to another
Parameters
Name | Type |
---|---|
value | unknown |
other | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:102
isGreaterThanOrEqualToFP
▸ isGreaterThanOrEqualToFP(other
): (value
: unknown
) => boolean
Check if a value is greater than or equal to another
Parameters
Name | Type |
---|---|
other | unknown |
Returns
fn
▸ (value
): boolean
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:111
isLessThan
▸ isLessThan(value
, other
): boolean
Check if a value is less than another
Parameters
Name | Type |
---|---|
value | unknown |
other | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:162
isLessThanFP
▸ isLessThanFP(other
): (value
: unknown
) => boolean
Check if a value is greater than or equal to another
Parameters
Name | Type |
---|---|
other | unknown |
Returns
fn
▸ (value
): boolean
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:171
isLessThanOrEqualTo
▸ isLessThanOrEqualTo(value
, other
): boolean
Check if a value is less than or equal to another
Parameters
Name | Type |
---|---|
value | unknown |
other | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:142
isLessThanOrEqualToFP
▸ isLessThanOrEqualToFP(other
): (value
: unknown
) => boolean
Check if a value is less than or equal to another
Parameters
Name | Type |
---|---|
other | unknown |
Returns
fn
▸ (value
): boolean
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
packages/utils/src/equality.ts:151
isSame
▸ isSame<T
>(target
, input
): input is T
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
input is T
Deprecated
use isDeepEqual instead
Defined in
packages/utils/src/equality.ts:45
▸ isSame<T
>(target
, input
): boolean
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
target | T |
input | unknown |
Returns
boolean
Deprecated
use isDeepEqual instead