diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md index 82696c29ba94..8b03c0919ad3 100644 --- a/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/README.md @@ -519,7 +519,7 @@ var idx = arr.indexOf( 5.0 ); #### TypedArrayFE.prototype.includes( searchElement\[, fromIndex] ) -Returns `true` if the specified `searchElement` is present in the array. +Returns a boolean indicating whether an array includes a provided value. ```javascript var Float64ArrayFE = fixedEndianFactory( 'float64' ); @@ -534,16 +534,8 @@ idx = arr.includes( 2.0, 2 ); idx = arr.includes( 2.0, -4 ); // returns true -``` - -If the specified `searchElement` is not present in the array, the method returns `false`. - -```javascript -var Float64ArrayFE = fixedEndianFactory( 'float64' ); - -var arr = new Float64ArrayFE( 'little-endian', [ 1.0, 2.0, 3.0, 4.0, 2.0 ] ); -var idx = arr.includes( 5.0 ); +idx = arr.includes( 5.0 ); // returns false ``` diff --git a/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js b/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js index c38d42eaa1f3..fe31d4326e25 100644 --- a/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js +++ b/lib/node_modules/@stdlib/array/fixed-endian-factory/lib/main.js @@ -675,18 +675,19 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli } return -1; }); + /** - * Returns `true` if the specified `searchElement` is present in the array. + * Returns a boolean indicating whether an array includes a provided value. * * @private * @name includes * @memberof TypedArray.prototype * @type {Function} - * @param {*} searchElement - element to search for + * @param {*} searchElement - search element * @param {integer} [fromIndex=0] - starting index (inclusive) * @throws {TypeError} `this` must be a typed array instance * @throws {TypeError} second argument must be an integer - * @returns {boolean} boolean indicating that `searchElement` is found + * @returns {boolean} boolean indicating whether an array includes a provided value */ setReadOnly( TypedArray.prototype, 'includes', function includes( searchElement, fromIndex ) { var buf;