index.js (1432B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2021 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Return a regular expression to parse a UNC path. 23 * 24 * @module @stdlib/regexp/unc-path 25 * 26 * @example 27 * var reUncPath = require( '@stdlib/regexp/unc-path' ); 28 * 29 * var RE_UNC_PATH = reUncPath(); 30 * var bool = RE_UNC_PATH.test( '\\\\server\\share' ); 31 * // returns true 32 * 33 * bool = RE_UNC_PATH.test( 'C:\\foo\\bar\\baz' ); 34 * // returns false 35 * 36 * @example 37 * var reUncPath = require( '@stdlib/regexp/unc-path' ); 38 * 39 * var parts = reUncPath.REGEXP.exec( '\\\\server\\share\\foo\\bar\\baz' )[ 1 ]; 40 * // returns 'server' 41 */ 42 43 44 // MODULES // 45 46 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 47 var reUncPath = require( './main.js' ); 48 var REGEXP = require( './regexp.js' ); 49 50 51 // MAIN // 52 53 setReadOnly( reUncPath, 'REGEXP', REGEXP ); 54 55 56 // EXPORTS // 57 58 module.exports = reUncPath;