time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1698B)

      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 # isArrayArray
     22 
     23 > Test if a value is an array of arrays.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isArrayArray = require( '@stdlib/assert/is-array-array' );
     31 ```
     32 
     33 #### isArrayArray( value )
     34 
     35 Tests if a `value` is an `array` of `arrays`.
     36 
     37 ```javascript
     38 var bool = isArrayArray( [ [], [] ] );
     39 // returns true
     40 
     41 bool = isArrayArray( [ {}, {} ] );
     42 // returns false
     43 
     44 bool = isArrayArray( [] );
     45 // returns false
     46 
     47 bool = isArrayArray( {} );
     48 // returns false
     49 
     50 bool = isArrayArray( [ null, {} ] );
     51 // returns false
     52 ```
     53 
     54 </section>
     55 
     56 <!-- /.usage -->
     57 
     58 <section class="examples">
     59 
     60 ## Examples
     61 
     62 <!-- eslint no-undef: "error" -->
     63 
     64 ```javascript
     65 var isArrayArray = require( '@stdlib/assert/is-array-array' );
     66 
     67 var bool = isArrayArray( [ [], [], [] ] );
     68 // returns true
     69 
     70 bool = isArrayArray( [ [], {} ] );
     71 // returns false
     72 
     73 bool = isArrayArray( [] );
     74 // returns false
     75 
     76 bool = isArrayArray( {} );
     77 // returns false
     78 
     79 bool = isArrayArray( [ 'a', 'b' ] );
     80 // returns false
     81 
     82 bool = isArrayArray( null );
     83 // returns false
     84 ```
     85 
     86 </section>
     87 
     88 <!-- /.examples -->
     89 
     90 <section class="links">
     91 
     92 </section>
     93 
     94 <!-- /.links -->