@terascope/core-utils / equality
equality
Functions
isDeepEqual()
Call Signature
isDeepEqual<
T>(target,input):input is T
Defined in: packages/core-utils/src/equality.ts:46
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
| Type Parameter |
|---|
T |
Parameters
| Parameter | 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;
Call Signature
isDeepEqual<
T>(target,input):boolean
Defined in: packages/core-utils/src/equality.ts:47
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
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
input | unknown |
Returns
boolean
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;
isDeepEqualFP()
Call Signature
isDeepEqualFP<
T>(target): (input) =>input is T
Defined in: packages/core-utils/src/equality.ts:70
A functional version of isDeepEqual
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
Returns
(input) => input is T
Call Signature
isDeepEqualFP<
T>(target): (input) =>boolean
Defined in: packages/core-utils/src/equality.ts:71
A functional version of isDeepEqual
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
Returns
(input) => boolean
isEqual()
Call Signature
isEqual<
T>(target,input):input is T
Defined in: packages/core-utils/src/equality.ts:10
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
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
input | unknown |
Returns
input is T
Call Signature
isEqual<
T>(target,input):boolean
Defined in: packages/core-utils/src/equality.ts:11
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
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
input | unknown |
Returns
boolean
isEqualFP()
Call Signature
isEqualFP<
T>(target): (input) =>input is T
Defined in: packages/core-utils/src/equality.ts:19
A functional version of isEqual
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
Returns
(input) => input is T
Call Signature
isEqualFP<
T>(target): (input) =>boolean
Defined in: packages/core-utils/src/equality.ts:20
A functional version of isEqual
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
target | T |
Returns
(input) => boolean
isGreaterThan()
isGreaterThan(
value,other):boolean
Defined in: packages/core-utils/src/equality.ts:118
Check if a value is greater than another
Parameters
| Parameter | Type |
|---|---|
value | unknown |
other | unknown |
Returns
boolean
isGreaterThanFP()
isGreaterThanFP(
other): (value) =>boolean
Defined in: packages/core-utils/src/equality.ts:127
Check if a value is greater than or equal to another
Parameters
| Parameter | Type |
|---|---|
other | unknown |
Returns
(value) => boolean
isGreaterThanOrEqualTo()
isGreaterThanOrEqualTo(
value,other):boolean
Defined in: packages/core-utils/src/equality.ts:98
Check if a value is greater than or equal to another
Parameters
| Parameter | Type |
|---|---|
value | unknown |
other | unknown |
Returns
boolean
isGreaterThanOrEqualToFP()
isGreaterThanOrEqualToFP(
other): (value) =>boolean
Defined in: packages/core-utils/src/equality.ts:107
Check if a value is greater than or equal to another
Parameters
| Parameter | Type |
|---|---|
other | unknown |
Returns
(value) => boolean
isLessThan()
isLessThan(
value,other):boolean
Defined in: packages/core-utils/src/equality.ts:158
Check if a value is less than another
Parameters
| Parameter | Type |
|---|---|
value | unknown |
other | unknown |
Returns
boolean
isLessThanFP()
isLessThanFP(
other): (value) =>boolean
Defined in: packages/core-utils/src/equality.ts:167
Check if a value is greater than or equal to another
Parameters
| Parameter | Type |
|---|---|
other | unknown |
Returns
(value) => boolean
isLessThanOrEqualTo()
isLessThanOrEqualTo(
value,other):boolean
Defined in: packages/core-utils/src/equality.ts:138
Check if a value is less than or equal to another
Parameters
| Parameter | Type |
|---|---|
value | unknown |
other | unknown |
Returns
boolean
isLessThanOrEqualToFP()
isLessThanOrEqualToFP(
other): (value) =>boolean
Defined in: packages/core-utils/src/equality.ts:147
Check if a value is less than or equal to another
Parameters
| Parameter | Type |
|---|---|
other | unknown |
Returns
(value) => boolean