time-to-botec

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

README.md (2003B)

      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 # Node Version
     22 
     23 > Node version.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var NODE_VERSION = require( '@stdlib/process/node-version' );
     31 ```
     32 
     33 #### NODE_VERSION
     34 
     35 Node version.
     36 
     37 ```javascript
     38 console.log( NODE_VERSION );
     39 // => <string>
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 ## Notes
     49 
     50 -   In browser environments and environments other than Node.js the Node version is equal to `null`.
     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 semver = require( 'semver' );
     64 var NODE_VERSION = require( '@stdlib/process/node-version' );
     65 
     66 if ( semver.lt( NODE_VERSION, '1.0.0' ) ) {
     67     console.log( 'Running on a pre-io.js version...' );
     68 }
     69 else if ( semver.lt( NODE_VERSION, '4.0.0' ) ) {
     70     console.log( 'Running on an io.js version...' );
     71 }
     72 else {
     73     console.log( 'Running on a post-io.js version...' );
     74 }
     75 ```
     76 
     77 </section>
     78 
     79 <!-- /.examples -->
     80 
     81 * * *
     82 
     83 <section class="cli">
     84 
     85 ## CLI
     86 
     87 <section class="usage">
     88 
     89 ### Usage
     90 
     91 ```text
     92 Usage: node-version [options]
     93 
     94 Options:
     95 
     96   -h,    --help                Print this message.
     97   -V,    --version             Print the package version.
     98 ```
     99 
    100 </section>
    101 
    102 <!-- /.usage -->
    103 
    104 <section class="examples">
    105 
    106 ### Examples
    107 
    108 ```bash
    109 $ node-version
    110 <node_version>
    111 ```
    112 
    113 </section>
    114 
    115 <!-- /.examples -->
    116 
    117 </section>
    118 
    119 <!-- /.cli -->
    120 
    121 <section class="links">
    122 
    123 </section>
    124 
    125 <!-- /.links -->