time-to-botec

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

README.md (1332B)


      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 # IS_TOUCH_DEVICE
     22 
     23 > Check if the current environment is a touch device.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var IS_TOUCH_DEVICE = require( '@stdlib/assert/is-touch-device' );
     31 ```
     32 
     33 #### IS_TOUCH_DEVICE
     34 
     35 `Boolean` indicating if the current environment is a touch device.
     36 
     37 ```javascript
     38 var bool = IS_TOUCH_DEVICE;
     39 // returns <boolean>
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 </section>
     49 
     50 <!-- /.notes -->
     51 
     52 <section class="examples">
     53 
     54 ## Examples
     55 
     56 <!-- eslint no-undef: "error" -->
     57 
     58 ```javascript
     59 var IS_TOUCH_DEVICE = require( '@stdlib/assert/is-touch-device' );
     60 
     61 console.log( IS_TOUCH_DEVICE );
     62 // => <boolean>
     63 ```
     64 
     65 </section>
     66 
     67 <!-- /.examples -->
     68 
     69 <section class="links">
     70 
     71 </section>
     72 
     73 <!-- /.links -->