Arrays.equal()

Syntax

function equal(array1: readonly unknown[], array2: readonly unknown[]): boolean

Example

import { Arrays } from 'potence';

console.log(Arrays.equal([2, 5, 3], [2, 5, 3]));             // -> true
console.log(Arrays.equal([new Object()], [new Object()]));   // -> false

Remarks

If the array is composed of reference types (i.e. objects, arrays, or functions), this function only compares their references, not the contents. If the array is composed of data types (i.e. booleans, numbers, strings, BigInts, symbols, as well as null or undefined), this function checks their structural equality. For more information on data and structural types, click here.

If the arrays do not have the same length, the function automatically returns false without comparing the contents.