208 lines
4.7 KiB
Markdown
208 lines
4.7 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# UNC Path
|
|
|
|
> [Regular expression][regexp] to parse a [UNC][unc] path.
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var reUncPath = require( '@stdlib/regexp/unc-path' );
|
|
```
|
|
|
|
#### reUncPath()
|
|
|
|
Return a [regular expression][regexp] to parse a [UNC][unc] path.
|
|
|
|
```javascript
|
|
var RE_UNC_PATH = reUncPath();
|
|
var parts = RE_UNC_PATH.exec( '\\\\server\\share\\foo\\bar\\baz:a:b' );
|
|
/* returns
|
|
[
|
|
'\\\\server\\share\\foo\\bar\\baz:a:b',
|
|
'server', // host name
|
|
'share', // share name
|
|
'\\foo\\bar\\baz:a:b', // object name
|
|
'\\foo\\bar', // path name
|
|
'baz:a:b', // file name
|
|
'a', // stream name
|
|
'b', // stream type
|
|
'index': 0,
|
|
'input': '\\\\server\\share\\foo\\bar\\baz:a:b'
|
|
]
|
|
*/
|
|
|
|
parts = RE_UNC_PATH.exec( '\\\\server\\share' );
|
|
/* returns
|
|
[
|
|
'\\\\server\\share',
|
|
'server', // host name
|
|
'share', // share name
|
|
'', // object name
|
|
undefined, // path name
|
|
undefined, // file name
|
|
undefined, // stream name
|
|
undefined, // stream type
|
|
'index': 0,
|
|
'input': '\\\\server\\share'
|
|
]
|
|
*/
|
|
```
|
|
|
|
#### reUncPath.REGEXP
|
|
|
|
[Regular expression][regexp] to parse a [UNC][unc] path.
|
|
|
|
```javascript
|
|
var parts = reUncPath.REGEXP.exec( '\\\\server\\share\\foo\\bar\\baz' )[ 1 ];
|
|
// returns 'server'
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var reUncPath = require( '@stdlib/regexp/unc-path' );
|
|
|
|
var RE_UNC_PATH = reUncPath();
|
|
var bool;
|
|
var path;
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz:a:b';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz::b';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz:a';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share\\foo\\bar';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share\\foo';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\share';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns true
|
|
|
|
path = '\\\\server\\\\share';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\\\\\server\\share';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = 'beep boop \\\\server\\share';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz:';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz:a:';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz::';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\baz:a:b:c';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '\\\\server\\share\\foo\\bar\\';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '//server/share';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '/foo/bar';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = 'foo/bar';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = './foo/bar';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
|
|
path = '/foo/../bar';
|
|
bool = RE_UNC_PATH.test( path );
|
|
// returns false
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
[regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
|
|
|
[unc]: https://msdn.microsoft.com/en-us/library/gg465305.aspx
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|