time-to-botec

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

README.md (2231B)

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