time-to-botec

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

README.md (1826B)

      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 # cwd
     22 
     23 > Return the current working directory.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var cwd = require( '@stdlib/process/cwd' );
     31 ```
     32 
     33 #### cwd()
     34 
     35 Returns the current working directory.
     36 
     37 ```javascript
     38 var dir = cwd();
     39 // e.g., returns '/path/to/current/working/directory'
     40 ```
     41 
     42 </section>
     43 
     44 <!-- /.usage -->
     45 
     46 <section class="notes">
     47     
     48 ## Notes
     49 
     50 -   In browser environments, the current working directory is always equal to `'/'`.
     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 PATH_SEP = require( '@stdlib/constants/path/sep' );
     64 var cwd = require( '@stdlib/process/cwd' );
     65 
     66 var parts = cwd().split( PATH_SEP );
     67 console.log( parts );
     68 ```
     69 
     70 </section>
     71 
     72 <!-- /.examples -->
     73 
     74 * * *
     75 
     76 <section class="cli">
     77 
     78 ## CLI
     79 
     80 <section class="usage">
     81 
     82 ### Usage
     83 
     84 ```text
     85 Usage: cwd [options]
     86 
     87 Options:
     88 
     89   -h,    --help                Print this message.
     90   -V,    --version             Print the package version.
     91 ```
     92 
     93 </section>
     94 
     95 <!-- /.usage -->
     96 
     97 <section class="examples">
     98 
     99 ### Examples
    100 
    101 ```bash
    102 $ cwd
    103 /path/to/current/working/directory
    104 ```
    105 
    106 </section>
    107 
    108 <!-- /.examples -->
    109 
    110 </section>
    111 
    112 <!-- /.cli -->
    113 
    114 <section class="links">
    115 
    116 </section>
    117 
    118 <!-- /.links -->