time-to-botec

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

README.md (1967B)

      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 # isPrimitiveArray
     22 
     23 > Test if a value is an array-like object containing only JavaScript primitives.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isPrimitiveArray = require( '@stdlib/assert/is-primitive-array' );
     31 ```
     32 
     33 #### isPrimitiveArray( value )
     34 
     35 Tests if a `value` is an array-like object containing **only** JavaScript primitives.
     36 
     37 <!-- eslint-disable no-new-wrappers -->
     38 
     39 ```javascript
     40 var bool = isPrimitiveArray( [ '3', 2, null ] );
     41 // returns true
     42 
     43 bool = isPrimitiveArray( [ {}, 2, 1 ] );
     44 // returns false
     45 
     46 bool = isPrimitiveArray( [ new String( 'abc' ), '3.0' ] );
     47 // returns false
     48 ```
     49 
     50 </section>
     51 
     52 <!-- /.usage -->
     53 
     54 <section class="examples">
     55 
     56 ## Examples
     57 
     58 <!-- eslint-disable no-restricted-syntax, no-new-wrappers, no-empty-function -->
     59 
     60 <!-- eslint no-undef: "error" -->
     61 
     62 ```javascript
     63 var Number = require( '@stdlib/number/ctor' );
     64 var isPrimitiveArray = require( '@stdlib/assert/is-primitive-array' );
     65 
     66 var bool = isPrimitiveArray( [ '3', 2, null ] );
     67 // returns true
     68 
     69 bool = isPrimitiveArray( [ void 0, true ] );
     70 // returns true
     71 
     72 bool = isPrimitiveArray( [ new String( 'abc' ), false ] );
     73 // returns false
     74 
     75 bool = isPrimitiveArray( [ new Number( 2 ), null ] );
     76 // returns false
     77 
     78 bool = isPrimitiveArray( [ function noop() {}, null ] );
     79 // returns false
     80 ```
     81 
     82 </section>
     83 
     84 <!-- /.examples -->
     85 
     86 <section class="links">
     87 
     88 </section>
     89 
     90 <!-- /.links -->