time-to-botec

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

README.md (2883B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 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 # isBigUint64Array
     22 
     23 > Test if a value is a [BigUint64Array][mdn-biguint64array].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isBigUint64Array = require( '@stdlib/assert/is-biguint64array' );
     31 ```
     32 
     33 #### isBigUint64Array( value )
     34 
     35 Tests if a value is a [`BigUint64Array`][mdn-biguint64array].
     36 
     37 <!-- eslint-disable stdlib/require-globals, no-undef -->
     38 
     39 ```javascript
     40 var bool = isBigUint64Array( new BigUint64Array( 10 ) );
     41 // returns true
     42 
     43 bool = isBigUint64Array( [] );
     44 // returns false
     45 ```
     46 
     47 </section>
     48 
     49 <!-- /.usage -->
     50 
     51 <section class="examples">
     52 
     53 ## Examples
     54 
     55 <!-- eslint no-undef: "error" -->
     56 
     57 <!-- eslint-disable stdlib/require-globals, no-undef -->
     58 
     59 ```javascript
     60 var Int8Array = require( '@stdlib/array/int8' );
     61 var Uint8Array = require( '@stdlib/array/uint8' );
     62 var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
     63 var Int16Array = require( '@stdlib/array/int16' );
     64 var Uint16Array = require( '@stdlib/array/uint16' );
     65 var Int32Array = require( '@stdlib/array/int32' );
     66 var Uint32Array = require( '@stdlib/array/uint32' );
     67 var Float32Array = require( '@stdlib/array/float32' );
     68 var Float64Array = require( '@stdlib/array/float64' );
     69 var isBigUint64Array = require( '@stdlib/assert/is-biguint64array' );
     70 
     71 var bool = isBigUint64Array( new BigUint64Array( 10 ) );
     72 // returns true
     73 
     74 bool = isBigUint64Array( new Int8Array( 10 ) );
     75 // returns false
     76 
     77 bool = isBigUint64Array( new Uint8Array( 10 ) );
     78 // returns false
     79 
     80 bool = isBigUint64Array( new Uint8ClampedArray( 10 ) );
     81 // returns false
     82 
     83 bool = isBigUint64Array( new Int16Array( 10 ) );
     84 // returns false
     85 
     86 bool = isBigUint64Array( new Uint16Array( 10 ) );
     87 // returns false
     88 
     89 bool = isBigUint64Array( new Int32Array( 10 ) );
     90 // returns false
     91 
     92 bool = isBigUint64Array( new Uint32Array( 10 ) );
     93 // returns false
     94 
     95 bool = isBigUint64Array( new Float64Array( 10 ) );
     96 // returns false
     97 
     98 bool = isBigUint64Array( new Float32Array( 10 ) );
     99 // returns false
    100 
    101 bool = isBigUint64Array( new Array( 10 ) );
    102 // returns false
    103 
    104 bool = isBigUint64Array( {} );
    105 // returns false
    106 
    107 bool = isBigUint64Array( null );
    108 // returns false
    109 ```
    110 
    111 </section>
    112 
    113 <!-- /.examples -->
    114 
    115 <section class="links">
    116 
    117 [mdn-biguint64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigUint64Array
    118 
    119 </section>
    120 
    121 <!-- /.links -->