Skip to content

Latest commit

 

History

History
290 lines (183 loc) · 8.4 KB

README.md

File metadata and controls

290 lines (183 loc) · 8.4 KB
About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

contains

NPM version Build Status Coverage Status

Test if an array-like value contains a search value.

Usage

To use in Observable,

contains = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-contains@umd/browser.js' )

To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:

var contains = require( 'path/to/vendor/umd/assert-contains/index.js' )

To include the bundle in a webpage,

<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/assert-contains@umd/browser.js"></script>

If no recognized module system is present, access bundle contents via the global scope:

<script type="text/javascript">
(function () {
    window.contains;
})();
</script>

contains( value, searchValue[, position] )

Tests if value contains a search value.

var v = contains( [ 1, 2, 3 ], 2 );
// returns true

When value is a string, the function checks whether the characters of a search string are found in the input string.

var v = contains( 'Hello World', 'World' );
// returns true

When value is an array-like object, but not a string, the function checks whether the input value contains an element which is the same value as the specified search value.

var arr = [ null, NaN, 2, 'abc', {} ];

var v = contains( arr, NaN ); // NaNs are considered equal
// returns true

v = contains( arr, {} );
// returns false

v = contains( arr, 'ab' );
// returns false

Search is case-sensitive.

var v = contains( 'Hello World', 'world' );
// returns false

To start searching at a specified index, provide a position argument.

var v = contains( 'Hello World', 'Hello', 6 );
// returns false

v = contains( [ true, NaN, false ], true, 1 );
// returns false

If not provided an array-like object, the function throws an error.

var v = contains( false, 'abc' );
// throws <TypeError>

If not provided an integer-valued position argument, the function throws an error.

var v = contains( 'hello', 'e', 2.5 );
// throws <TypeError>

Notes

  • For strings, the function is modeled after String.prototype.includes, part of the ECMAScript 6 specification. This function is different from a call to String.prototype.includes.call insofar as type-checking is performed for all arguments.
  • The function does distinguish between positive and negative zero (see @stdlib/assert-is-same-value.
  • If position < 0, the search is performed for the entire input array or string.

Examples

<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/assert-contains@umd/browser.js"></script>
<script type="text/javascript">
(function () {

var bool = contains( 'last man standing', 'stand' );
// returns true

bool = contains( [ 1, 2, 3, 4 ], 2 );
// returns true

bool = contains( 'presidential election', 'president' );
// returns true

bool = contains( [ NaN, 2, 3, 4 ], NaN );
// returns true

bool = contains( 'javaScript', 'js' );
// returns false

bool = contains( 'Hidden Treasures', '' );
// returns true

})();
</script>
</body>
</html>

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

Chat

License

See LICENSE.

Copyright

Copyright © 2016-2025. The Stdlib Authors.