time-to-botec

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

README.md (3156B)

      1 <!--
      2 
      3 @license Apache-2.0
      4 
      5 Copyright (c) 2021 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 # String Path Constants
     22 
     23 > Standard library string path constants.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var constants = require( '@stdlib/constants/path' );
     31 ```
     32 
     33 #### constants
     34 
     35 Standard library string path constants.
     36 
     37 ```javascript
     38 var ns = constants;
     39 // returns {...}
     40 ```
     41 
     42 <!-- <toc pattern="*"> -->
     43 
     44 <div class="namespace-toc">
     45 
     46 -   <span class="signature">[`DELIMITER_POSIX`][@stdlib/constants/path/delimiter-posix]</span><span class="delimiter">: </span><span class="description">POSIX path delimiter.</span>
     47 -   <span class="signature">[`DELIMITER_WIN32`][@stdlib/constants/path/delimiter-win32]</span><span class="delimiter">: </span><span class="description">Windows path delimiter.</span>
     48 -   <span class="signature">[`DELIMITER`][@stdlib/constants/path/delimiter]</span><span class="delimiter">: </span><span class="description">platform-specific path delimiter.</span>
     49 -   <span class="signature">[`SEP_POSIX`][@stdlib/constants/path/sep-posix]</span><span class="delimiter">: </span><span class="description">POSIX path segment separator.</span>
     50 -   <span class="signature">[`SEP_WIN32`][@stdlib/constants/path/sep-win32]</span><span class="delimiter">: </span><span class="description">Windows path segment separator.</span>
     51 -   <span class="signature">[`SEP`][@stdlib/constants/path/sep]</span><span class="delimiter">: </span><span class="description">platform-specific path segment separator.</span>
     52 
     53 </div>
     54 
     55 <!-- </toc> -->
     56 
     57 </section>
     58 
     59 <!-- /.usage -->
     60 
     61 <section class="examples">
     62 
     63 ## Examples
     64 
     65 <!-- TODO: better examples -->
     66 
     67 <!-- eslint no-undef: "error" -->
     68 
     69 ```javascript
     70 var objectKeys = require( '@stdlib/utils/keys' );
     71 var constants = require( '@stdlib/constants/path' );
     72 
     73 console.log( objectKeys( constants ) );
     74 ```
     75 
     76 </section>
     77 
     78 <!-- /.examples -->
     79 
     80 <section class="links">
     81 
     82 <!-- <toc-links> -->
     83 
     84 [@stdlib/constants/path/delimiter-posix]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/delimiter-posix
     85 
     86 [@stdlib/constants/path/delimiter-win32]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/delimiter-win32
     87 
     88 [@stdlib/constants/path/delimiter]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/delimiter
     89 
     90 [@stdlib/constants/path/sep-posix]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/sep-posix
     91 
     92 [@stdlib/constants/path/sep-win32]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/sep-win32
     93 
     94 [@stdlib/constants/path/sep]: https://www.npmjs.com/package/@stdlib/constants/tree/main/path/sep
     95 
     96 <!-- </toc-links> -->
     97 
     98 </section>
     99 
    100 <!-- /.links -->