time-to-botec/js/node_modules/@stdlib/regexp/unc-path/lib/index.js

59 lines
1.4 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2021 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.
*/
'use strict';
/**
* Return a regular expression to parse a UNC path.
*
* @module @stdlib/regexp/unc-path
*
* @example
* var reUncPath = require( '@stdlib/regexp/unc-path' );
*
* var RE_UNC_PATH = reUncPath();
* var bool = RE_UNC_PATH.test( '\\\\server\\share' );
* // returns true
*
* bool = RE_UNC_PATH.test( 'C:\\foo\\bar\\baz' );
* // returns false
*
* @example
* var reUncPath = require( '@stdlib/regexp/unc-path' );
*
* var parts = reUncPath.REGEXP.exec( '\\\\server\\share\\foo\\bar\\baz' )[ 1 ];
* // returns 'server'
*/
// MODULES //
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var reUncPath = require( './main.js' );
var REGEXP = require( './regexp.js' );
// MAIN //
setReadOnly( reUncPath, 'REGEXP', REGEXP );
// EXPORTS //
module.exports = reUncPath;