74 lines
1.6 KiB
JavaScript
74 lines
1.6 KiB
JavaScript
|
/**
|
||
|
|
* @license Apache-2.0
|
||
|
|
*
|
||
|
|
* Copyright (c) 2018 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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return the first index at which a given element can be found.
|
||
|
|
*
|
||
|
|
* @module @stdlib/utils/index-of
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* var indexOf = require( '@stdlib/utils/index-of' );
|
||
|
|
*
|
||
|
|
* var arr = [ 4, 3, 2, 1 ];
|
||
|
|
* var idx = indexOf( arr, 3 );
|
||
|
|
* // returns 1
|
||
|
|
*
|
||
|
|
* arr = [ 4, 3, 2, 1 ];
|
||
|
|
* idx = indexOf( arr, 5 );
|
||
|
|
* // returns -1
|
||
|
|
*
|
||
|
|
* // Using a `fromIndex`:
|
||
|
|
* arr = [ 1, 2, 3, 4, 5, 2, 6 ];
|
||
|
|
* idx = indexOf( arr, 2, 3 );
|
||
|
|
* // returns 5
|
||
|
|
*
|
||
|
|
* // `fromIndex` which exceeds `array` length:
|
||
|
|
* arr = [ 1, 2, 3, 4, 2, 5 ];
|
||
|
|
* idx = indexOf( arr, 2, 10 );
|
||
|
|
* // returns -1
|
||
|
|
*
|
||
|
|
* // Negative `fromIndex`:
|
||
|
|
* arr = [ 1, 2, 3, 4, 5, 2, 6, 2 ];
|
||
|
|
* idx = indexOf( arr, 2, -4 );
|
||
|
|
* // returns 5
|
||
|
|
*
|
||
|
|
* idx = indexOf( arr, 2, -1 );
|
||
|
|
* // returns 7
|
||
|
|
*
|
||
|
|
* // Negative `fromIndex` exceeding input `array` length:
|
||
|
|
* arr = [ 1, 2, 3, 4, 5, 2, 6 ];
|
||
|
|
* idx = indexOf( arr, 2, -10 );
|
||
|
|
* // returns 1
|
||
|
|
*
|
||
|
|
* // Array-like objects:
|
||
|
|
* var str = 'bebop';
|
||
|
|
* idx = indexOf( str, 'o' );
|
||
|
|
* // returns 3
|
||
|
|
*/
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var indexOf = require( './index_of.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = indexOf;
|