main.js (1414B)
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 // MODULES // 22 23 var isCollection = require( '@stdlib/assert/is-collection' ); 24 25 26 // MAIN // 27 28 /** 29 * Tests whether at least one element in a collection is truthy. 30 * 31 * @param {Collection} collection - input collection 32 * @throws {TypeError} must provide a collection 33 * @returns {boolean} boolean indicating whether at least one element is truthy 34 * 35 * @example 36 * var arr = [ 0, 0, 0, 0, 1 ]; 37 * 38 * var bool = any( arr ); 39 * // returns true 40 */ 41 function any( collection ) { 42 var len; 43 var i; 44 if ( !isCollection( collection ) ) { 45 throw new TypeError( 'invalid argument. Must provide a collection. Value: `'+collection+'`.' ); 46 } 47 len = collection.length; 48 for ( i = 0; i < len; i++ ) { 49 if ( collection[ i ] ) { 50 return true; 51 } 52 } 53 return false; 54 } 55 56 57 // EXPORTS // 58 59 module.exports = any;