@stdlib/array-base-assert-contains

contains

Test if an array contains a provided search value.

Installation

npm install @stdlib/array-base-assert-contains

Usage

var contains = require( '@stdlib/array-base-assert-contains' );

contains( x, value )

Tests if an array contains a provided search value.

var x = [ 1, 2, 3 ];

var out = contains( x, 2 );
// returns true

contains.factory( x )

Returns a function which tests if an array contains a provided search value.

var x = [ 1, 2, 3 ];

var fcn = contains.factory( x );
// returns <Function>

var out = fcn( 2 );
// returns true

out = fcn( 4 );
// returns false

Examples

var AccessorArray = require( '@stdlib/array-base-accessor' );
var contains = require( '@stdlib/array-base-assert-contains' );

// Create an accessor array:
var arr = new AccessorArray( [ 1, 2, 3, 4 ] );

// Check whether the array contains various values...
var bool = contains( arr, 2 );
// returns true

bool = contains( arr, 4 );
// returns true

bool = contains( arr, 9 );
// returns false

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.