index.js (1257B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Find elements in an array-like object that satisfy a test condition. 23 * 24 * @module @stdlib/utils/find 25 * 26 * @example 27 * var find = require( '@stdlib/utils/find' ); 28 * 29 * var data = [ 30, 20, 50, 60, 10 ]; 30 * 31 * function condition( val ) { 32 * return val > 20; 33 * } 34 * 35 * var vals = find( data, condition ); 36 * // returns [ 0, 2, 3 ] 37 * 38 * data = [ 30, 20, 50, 60, 10 ]; 39 * var opts = { 40 * 'k': 2, 41 * 'returns': 'values' 42 * }; 43 * vals = find( data, opts, condition ); 44 * // returns [ 30, 50 ] 45 */ 46 47 // MODULES // 48 49 var find = require( './find.js' ); // eslint-disable-line stdlib/no-redeclare 50 51 52 // EXPORTS // 53 54 module.exports = find;