time-to-botec

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

README.md (2405B)

      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 # Dirname
     22 
     23 > [Regular expression][regexp] to capture a [POSIX][posix] path [dirname][dirname].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var reDirnamePosix = require( '@stdlib/regexp/dirname-posix' );
     31 ```
     32 
     33 #### reDirnamePosix()
     34 
     35 Returns a [regular expression][regexp] to capture a [POSIX][posix] path [dirname][dirname]. 
     36 
     37 ```javascript
     38 var RE_DIRNAME_POSIX = reDirnamePosix();
     39 var dir = RE_DIRNAME_POSIX.exec( 'foo/bar/index.js' )[ 1 ];
     40 // returns 'foo/bar'
     41 ```
     42 
     43 #### reDirnamePosix.REGEXP
     44 
     45 [Regular expression][regexp] to capture a [POSIX][posix] path [dirname][dirname]. 
     46 
     47 ```javascript
     48 var dir = reDirnamePosix.REGEXP.exec( 'foo/bar/index.js' )[ 1 ];
     49 // returns 'foo/bar'
     50 ```
     51 
     52 </section>
     53 
     54 <!-- /.usage -->
     55 
     56 <section class="examples">
     57 
     58 ## Examples
     59 
     60 <!-- eslint no-undef: "error" -->
     61 
     62 ```javascript
     63 var reDirnamePosix = require( '@stdlib/regexp/dirname-posix' );
     64 
     65 var RE_DIRNAME_POSIX = reDirnamePosix();
     66 var dir;
     67 
     68 dir = RE_DIRNAME_POSIX.exec( 'index.js' )[ 1 ];
     69 // returns ''
     70 
     71 dir = RE_DIRNAME_POSIX.exec( '.' )[ 1 ];
     72 // returns '.'
     73 
     74 dir = RE_DIRNAME_POSIX.exec( './' )[ 1 ];
     75 // returns '.'
     76 
     77 dir = RE_DIRNAME_POSIX.exec( '/foo/bar/home.html' )[ 1 ];
     78 // returns '/foo/bar'
     79 
     80 dir = RE_DIRNAME_POSIX.exec( 'foo/file.pdf' )[ 1 ];
     81 // returns 'foo'
     82 
     83 dir = RE_DIRNAME_POSIX.exec( 'beep.' )[ 1 ];
     84 // returns ''
     85 
     86 dir = RE_DIRNAME_POSIX.exec( '' )[ 1 ];
     87 // returns ''
     88 
     89 dir = RE_DIRNAME_POSIX.exec( '/foo/bar/file' )[ 1 ];
     90 // returns '/foo/bar'
     91 
     92 dir = RE_DIRNAME_POSIX.exec( './foo/bar/.gitignore' )[ 1 ];
     93 // returns './foo/bar'
     94 ```
     95 
     96 </section>
     97 
     98 <!-- /.examples -->
     99 
    100 <section class="links">
    101 
    102 [regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
    103 
    104 [posix]: https://en.wikipedia.org/wiki/POSIX
    105 
    106 [dirname]: https://en.wikipedia.org/wiki/Dirname
    107 
    108 </section>
    109 
    110 <!-- /.links -->