UNPKG

@stdlib/assert

Version:

Standard assertion utilities.

111 lines (68 loc) 2.43 kB
<!-- @license Apache-2.0 Copyright (c) 2024 The Stdlib Authors. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> # isSameArrayLike > Test if two arguments are both array-like and have the [same values][@stdlib/assert/is-same-value]. <section class="usage"> ## Usage ```javascript var isSameArrayLike = require( '@stdlib/assert/is-same-array-like' ); ``` #### isSameArrayLike( v1, v2 ) Tests if two arguments are both array-like and have the [same values][@stdlib/assert/is-same-value]. ```javascript var x = [ 1.0, 2.0 ]; var y = [ 1.0, 2.0 ]; var bool = isSameArrayLike( x, y ); // returns true bool = isSameArrayLike( x, [ -1.0, 2.0 ] ); // returns false ``` </section> <!-- /.usage --> <section class="notes"> ## Notes - In contrast to the strict equality operator `===`, the function distinguishes between `+0` and `-0` and treats `NaNs` as the [same value][@stdlib/assert/is-same-value]. </section> <!-- /.notes --> <section class="examples"> ## Examples <!-- eslint no-undef: "error" --> ```javascript var isSameArrayLike = require( '@stdlib/assert/is-same-array-like' ); var x = [ 1.0, 2.0, 3.0 ]; var y = [ 1.0, 2.0, 3.0 ]; var out = isSameArrayLike( x, y ); // returns true x = [ -0.0, 0.0, -0.0 ]; y = [ 0.0, -0.0, 0.0 ]; out = isSameArrayLike( x, y ); // returns false x = [ NaN, NaN, NaN ]; y = [ NaN, NaN, NaN ]; out = isSameArrayLike( x, y ); // returns true ``` </section> <!-- /.examples --> <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> <section class="related"> </section> <!-- /.related --> <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> <section class="links"> [@stdlib/assert/is-same-value]: https://github.com/stdlib-js/assert/tree/main/is-same-value <!-- <related-links> --> <!-- </related-links> --> </section> <!-- /.links -->