README.md (1637B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # isTruthyArray 22 23 > Test if a value is an array-like object containing only truthy values. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isTruthyArray = require( '@stdlib/assert/is-truthy-array' ); 31 ``` 32 33 #### isTruthyArray( value ) 34 35 Tests if a `value` is an array-like `object` containing only truthy values. 36 37 ```javascript 38 var bool = isTruthyArray( [ [], {} ] ); 39 // returns true 40 41 bool = isTruthyArray( [ '', null, void 0, false, 0, NaN ] ); 42 // returns false 43 ``` 44 45 </section> 46 47 <!-- /.usage --> 48 49 <section class="examples"> 50 51 ## Examples 52 53 <!-- eslint no-undef: "error" --> 54 55 ```javascript 56 var isTruthyArray = require( '@stdlib/assert/is-truthy-array' ); 57 58 var bool = isTruthyArray( [ [], {}, true, 'a', 5, -5 ] ); 59 // returns true 60 61 bool = isTruthyArray( [ null, '', NaN, 0, void 0, false ] ); 62 // returns false 63 64 bool = isTruthyArray( [] ); 65 // returns false 66 67 bool = isTruthyArray( true ); 68 // returns false 69 70 bool = isTruthyArray( {} ); 71 // returns false 72 ``` 73 74 </section> 75 76 <!-- /.examples --> 77 78 <section class="links"> 79 80 </section> 81 82 <!-- /.links -->