time-to-botec

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

README.md (2350B)

      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 # Generator Support
     22 
     23 > Detect native [`generator function`][generator-function] support.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var hasGeneratorSupport = require( '@stdlib/assert/has-generator-support' );
     31 ```
     32 
     33 #### hasGeneratorSupport()
     34 
     35 Detects if a runtime environment supports ES2015 [`generator functions`][generator-function], i.e. `function*()`.
     36 
     37 ```javascript
     38 var bool = hasGeneratorSupport();
     39 // returns <boolean>
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 ## Notes
     49 
     50 -   The implementation uses code evaluation, which may be problematic in browser contexts enforcing a strict [content security policy][mdn-csp] (CSP).
     51 
     52 </section>
     53 
     54 <!-- /.notes -->
     55 
     56 <section class="examples">
     57 
     58 ## Examples
     59 
     60 <!-- eslint no-undef: "error" -->
     61 
     62 ```javascript
     63 var hasGeneratorSupport = require( '@stdlib/assert/has-generator-support' );
     64 
     65 var bool = hasGeneratorSupport();
     66 if ( bool ) {
     67     console.log( 'Environment has native generator function support.' );
     68 } else {
     69     console.log( 'Environment lacks native generator function support.' );
     70 }
     71 ```
     72 
     73 </section>
     74 
     75 <!-- /.examples -->
     76 
     77 * * *
     78 
     79 <section class="cli">
     80 
     81 ## CLI
     82 
     83 <section class="usage">
     84 
     85 ### Usage
     86 
     87 ```text
     88 Usage: has-generator-support [options]
     89 
     90 Options:
     91 
     92   -h,    --help                Print this message.
     93   -V,    --version             Print the package version.
     94 ```
     95 
     96 </section>
     97 
     98 <!-- /.usage -->
     99 
    100 <section class="examples">
    101 
    102 ### Examples
    103 
    104 ```bash
    105 $ has-generator-support
    106 <boolean>
    107 ```
    108 
    109 </section>
    110 
    111 <!-- /.examples -->
    112 
    113 </section>
    114 
    115 <!-- /.cli -->
    116 
    117 <section class="links">
    118 
    119 [generator-function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*
    120 
    121 [mdn-csp]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
    122 
    123 </section>
    124 
    125 <!-- /.links -->