time-to-botec

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

README.md (2151B)

      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 # Extended Length Path
     22 
     23 > [Regular expression][regexp] to detect an [extended-length path][extended-length-path].
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var reExtendedLengthPath = require( '@stdlib/regexp/extended-length-path' );
     31 ```
     32 
     33 #### reExtendedLengthPath()
     34 
     35 Returns a [regular expression][regexp] to detect an [extended-length path][extended-length-path] (i.e., a Windows path which begins with the characters `\\?\`). 
     36 
     37 ```javascript
     38 var RE = reExtendedLengthPath();
     39 var bool = RE.test( '\\\\?\\C:\\foo\\bar' );
     40 // returns true
     41 ```
     42 
     43 </section>
     44 
     45 <!-- /.usage -->
     46 
     47 <section class="examples">
     48 
     49 ## Examples
     50 
     51 <!-- eslint no-undef: "error" -->
     52 
     53 ```javascript
     54 var reExtendedLengthPath = require( '@stdlib/regexp/extended-length-path' );
     55 
     56 var RE_EXTENDED_LENGTH_PATH = reExtendedLengthPath();
     57 var bool;
     58 var path;
     59 
     60 path = '\\\\?\\C:\\foo\\bar';
     61 bool = RE_EXTENDED_LENGTH_PATH.test( path );
     62 // returns true
     63 
     64 path = '\\\\?\\UNC\\server\\share';
     65 bool = RE_EXTENDED_LENGTH_PATH.test( path );
     66 // returns true
     67 
     68 path = 'C:\\foo\\bar';
     69 bool = RE_EXTENDED_LENGTH_PATH.test( path );
     70 // returns false
     71 
     72 path = '/c/foo/bar';
     73 bool = RE_EXTENDED_LENGTH_PATH.test( path );
     74 // returns false
     75 
     76 path = '/foo/bar';
     77 bool = RE_EXTENDED_LENGTH_PATH.test( path );
     78 // returns false
     79 ```
     80 
     81 </section>
     82 
     83 <!-- /.examples -->
     84 
     85 <section class="links">
     86 
     87 [regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
     88 
     89 [extended-length-path]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
     90 
     91 </section>
     92 
     93 <!-- /.links -->