time-to-botec

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

README.md (2299B)

      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 Windows path [dirname][dirname].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var reDirnameWindows = require( '@stdlib/regexp/dirname-windows' );
     31 ```
     32 
     33 #### reDirnameWindows()
     34 
     35 Returns a [regular expression][regexp] to capture a Windows path [dirname][dirname]. 
     36 
     37 ```javascript
     38 var RE_DIRNAME_WINDOWS = reDirnameWindows();
     39 var dir = RE_DIRNAME_WINDOWS.exec( 'foo\\bar\\index.js' )[ 1 ];
     40 // returns 'foo\\bar'
     41 ```
     42 
     43 #### reDirnameWindows.REGEXP
     44 
     45 [Regular expression][regexp] to capture a Windows path [dirname][dirname]. 
     46 
     47 ```javascript
     48 var dir = reDirnameWindows.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 reDirnameWindows = require( '@stdlib/regexp/dirname-windows' );
     64 
     65 var RE_DIRNAME_WINDOWS = reDirnameWindows();
     66 var dir;
     67 
     68 dir = RE_DIRNAME_WINDOWS.exec( 'index.js' )[ 1 ];
     69 // returns ''
     70 
     71 dir = RE_DIRNAME_WINDOWS.exec( 'C:\\foo\\bar\\home.html' )[ 1 ];
     72 // returns 'C:\\foo\\bar'
     73 
     74 dir = RE_DIRNAME_WINDOWS.exec( 'foo\\file.pdf' )[ 1 ];
     75 // returns 'foo'
     76 
     77 dir = RE_DIRNAME_WINDOWS.exec( 'beep\\boop.' )[ 1 ];
     78 // returns 'beep'
     79 
     80 dir = RE_DIRNAME_WINDOWS.exec( '' )[ 1 ];
     81 // returns ''
     82 
     83 dir = RE_DIRNAME_WINDOWS.exec( '\\foo\\bar\\file' )[ 1 ];
     84 // returns '\\foo\\bar'
     85 
     86 dir = RE_DIRNAME_WINDOWS.exec( 'C:\\foo\\bar\\.gitignore' )[ 1 ];
     87 // returns 'C:\\foo\\bar'
     88 ```
     89 
     90 </section>
     91 
     92 <!-- /.examples -->
     93 
     94 <section class="links">
     95 
     96 [regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
     97 
     98 [dirname]: https://en.wikipedia.org/wiki/Dirname
     99 
    100 </section>
    101 
    102 <!-- /.links -->