editor › Globals › ElementsEqual
Class: ElementsEqual
Utilities mostly for tests to ensure that arrays equal. Uses custom equality functions. Throws expect errors if flag is set.
Hierarchy
- ElementsEqual
Index
Methods
- _eq
- _equalOrderedStartAnywhere
- _equalOrderedStartFixed
- _equalUnordered
- eq
- orderedStartAnywhere
- orderedStartFixed
- unordered
Methods
Static Private _eq
▸ _eq‹T›(iterableA: readonly T[], iterableB: readonly T[], compare: function, ordered: OrderEquality): boolean
Defined in src/util/ElementsEqual.ts:96
Equality methods can assume: cycles are not null, have same length and length is not zero.
Type parameters:
▪ T
Parameters:
▪ iterableA: readonly T[]
-
▪ iterableB: readonly T[]
-
▪ compare: function
-
▸ (a: T, b: T): boolean
Parameters:
| Name | Type |
|---|---|
a |
T |
b |
T |
▪ ordered: OrderEquality
-
Returns: boolean
Static Private _equalOrderedStartAnywhere
▸ _equalOrderedStartAnywhere(iterableA: any, iterableB: any, compare: any): boolean
Defined in src/util/ElementsEqual.ts:152
Parameters:
| Name | Type |
|---|---|
iterableA |
any |
iterableB |
any |
compare |
any |
Returns: boolean
Static Private _equalOrderedStartFixed
▸ _equalOrderedStartFixed(cycleA: any, cycleB: any, compare: any): boolean
Defined in src/util/ElementsEqual.ts:126
Parameters:
| Name | Type |
|---|---|
cycleA |
any |
cycleB |
any |
compare |
any |
Returns: boolean
Static Private _equalUnordered
▸ _equalUnordered(iterableA: any, iterableB: any, compare: any): boolean
Defined in src/util/ElementsEqual.ts:136
Parameters:
| Name | Type |
|---|---|
iterableA |
any |
iterableB |
any |
compare |
any |
Returns: boolean
Static eq
▸ eq‹T›(iterableA: readonly T[], iterableB: readonly T[], compare: function, ordered: OrderEquality, throwExpectErrors: boolean): boolean
Defined in src/util/ElementsEqual.ts:24
Type parameters:
▪ T
Parameters:
▪ iterableA: readonly T[]
-
▪ iterableB: readonly T[]
-
▪ compare: function
-
▸ (a: T, b: T): boolean
Parameters:
| Name | Type |
|---|---|
a |
T |
b |
T |
▪Default value ordered: OrderEquality= OrderEquality.Unordered
-
▪Default value throwExpectErrors: boolean= false
-
Returns: boolean
Static orderedStartAnywhere
▸ orderedStartAnywhere‹T›(iterableA: readonly T[], iterableB: readonly T[], compare: function, throwExpectErrors: boolean): boolean
Defined in src/util/ElementsEqual.ts:63
Order matters but it could start anywhere.
Type parameters:
▪ T
Parameters:
▪ iterableA: readonly T[]
-
▪ iterableB: readonly T[]
-
▪ compare: function
-
▸ (a: T, b: T): boolean
Parameters:
| Name | Type |
|---|---|
a |
T |
b |
T |
▪Default value throwExpectErrors: boolean= false
-
Returns: boolean
Static orderedStartFixed
▸ orderedStartFixed‹T›(iterableA: readonly T[], iterableB: readonly T[], compare: function, throwExpectErrors: boolean): boolean
Defined in src/util/ElementsEqual.ts:79
Order matters (strictly).
Type parameters:
▪ T
Parameters:
▪ iterableA: readonly T[]
-
▪ iterableB: readonly T[]
-
▪ compare: function
-
▸ (a: T, b: T): boolean
Parameters:
| Name | Type |
|---|---|
a |
T |
b |
T |
▪Default value throwExpectErrors: boolean= false
-
Returns: boolean
Static unordered
▸ unordered‹T›(iterableA: readonly T[], iterableB: readonly T[], compare: function, throwExpectErrors: boolean): boolean
Defined in src/util/ElementsEqual.ts:47
Order doesn't matter at all.
Type parameters:
▪ T
Parameters:
▪ iterableA: readonly T[]
-
▪ iterableB: readonly T[]
-
▪ compare: function
-
▸ (a: T, b: T): boolean
Parameters:
| Name | Type |
|---|---|
a |
T |
b |
T |
▪Default value throwExpectErrors: boolean= false
-
Returns: boolean