time-to-botec

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

README.md (1856B)

      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 # Platform
     22 
     23 > Platform on which the current process is running.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var PLATFORM = require( '@stdlib/os/platform' );
     31 ```
     32 
     33 #### PLATFORM
     34 
     35 [Platform][process-platform] on which the current process is running.
     36 
     37 ```javascript
     38 console.log( PLATFORM );
     39 // => <string>
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="examples">
     47 
     48 ## Examples
     49 
     50 <!-- eslint no-undef: "error" -->
     51 
     52 ```javascript
     53 var PLATFORM = require( '@stdlib/os/platform' );
     54 
     55 if ( PLATFORM === 'win32' ) {
     56     console.log( 'Running on a PC...' );
     57 } else if ( PLATFORM === 'darwin' ) {
     58     console.log( 'Running on a Mac...' );
     59 } else {
     60     console.log( 'Running on something else...' );
     61 }
     62 ```
     63 
     64 </section>
     65 
     66 <!-- /.examples -->
     67 
     68 * * *
     69 
     70 <section class="cli">
     71 
     72 ## CLI
     73 
     74 <section class="usage">
     75 
     76 ### Usage
     77 
     78 ```text
     79 Usage: platform [options]
     80 
     81 Options:
     82 
     83   -h,    --help                Print this message.
     84   -V,    --version             Print the package version.
     85 ```
     86 
     87 </section>
     88 
     89 <!-- /.usage -->
     90 
     91 <section class="examples">
     92 
     93 ### Examples
     94 
     95 ```bash
     96 $ platform
     97 ```
     98 
     99 </section>
    100 
    101 <!-- /.examples -->
    102 
    103 </section>
    104 
    105 <!-- /.cli -->
    106 
    107 <section class="links">
    108 
    109 [process-platform]: https://nodejs.org/api/process.html#process_process_platform
    110 
    111 </section>
    112 
    113 <!-- /.links -->