time-to-botec

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

README.md (1865B)

      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 # ARGV
     22 
     23 > Array containing command-line arguments passed when launching the calling process.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var ARGV = require( '@stdlib/process/argv' );
     31 ```
     32 
     33 #### ARGV
     34 
     35 `Array` containing command-line arguments passed when launching the calling process.
     36 
     37 ```javascript
     38 var execPath = ARGV[ 0 ];
     39 // e.g., returns '/usr/local/bin/node'
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47 
     48 ## Notes
     49 
     50 -   The first element is the absolute pathname of the executable that started the calling process.
     51 -   The second element is the path of the executed file.
     52 -   Any additional elements are additional command-line arguments.
     53 -   In browser environments, `ARGV` is an **empty** array.
     54 -   Modifications to `ARGV` are local to the process in which `ARGV` is modified.
     55 -   Be careful when modifying command-line arguments as the argument array represents shared state. Accordingly, modifications affect all command-line argument consumers. 
     56 
     57 </section>
     58 
     59 <!-- /.notes -->
     60 
     61 <section class="examples">
     62 
     63 ## Examples
     64 
     65 <!-- eslint no-undef: "error" -->
     66 
     67 ```javascript
     68 var ARGV = require( '@stdlib/process/argv' );
     69 
     70 console.log( ARGV );
     71 // => [...]
     72 ```
     73 
     74 </section>
     75 
     76 <!-- /.examples -->
     77 
     78 <section class="links">
     79 
     80 </section>
     81 
     82 <!-- /.links -->