index.js (1779B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 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 * Test if a value is a relative path. 23 * 24 * @module @stdlib/assert/is-relative-path 25 * 26 * @example 27 * var IS_WINDOWS = require( '@stdlib/assert/is-windows' ); 28 * var isRelativePath = require( '@stdlib/assert/is-relative-path' ); 29 * 30 * var bool; 31 * if ( IS_WINDOWS ) { 32 * bool = isRelativePath( 'foo\\bar\\baz' ); 33 * // returns true 34 * 35 * bool = isRelativePath( 'C:\\foo\\..\\bar\\baz' ); 36 * // returns false 37 * } else { 38 * bool = isRelativePath( './foo/bar/baz' ); 39 * // returns true 40 * 41 * bool = isRelativePath( '/foo/../bar/baz' ); 42 * // returns false 43 * } 44 */ 45 46 // MODULES // 47 48 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); 49 var IS_WINDOWS = require( './../../is-windows' ); 50 var isRelativePathPosix = require( './posix.js' ); 51 var isRelativePathWin32 = require( './win32.js' ); 52 53 54 // MAIN // 55 56 var isRelativePath; 57 if ( IS_WINDOWS ) { 58 isRelativePath = isRelativePathWin32; 59 } else { 60 isRelativePath = isRelativePathPosix; 61 } 62 setReadOnly( isRelativePath, 'posix', isRelativePathPosix ); 63 setReadOnly( isRelativePath, 'win32', isRelativePathWin32 ); 64 65 66 // EXPORTS // 67 68 module.exports = isRelativePath;