Test if a value is a relative path.
npm install @stdlib/assert-is-relative-pathAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
var isRelativePath = require( '@stdlib/assert-is-relative-path' );Tests if a value is a relative path.
var IS_WINDOWS = require( '@stdlib/assert-is-windows' );
var bool;
if ( IS_WINDOWS ) {
bool = isRelativePath( 'foo\\bar\\baz' );
// returns true
bool = isRelativePath( 'C:\\foo\\..\\bar\\baz' );
// returns false
} else {
bool = isRelativePath( './foo/bar/baz' );
// returns true
bool = isRelativePath( '/foo/../bar/baz' );
// returns false
}Tests if a value is a POSIX relative path.
var bool = isRelativePath.posix( './foo/bar/baz' );
// returns true
bool = isRelativePath.posix( '/foo/../bar/baz' );
// returns falseTests if a value is a Windows relative path.
var bool = isRelativePath.win32( 'foo\\bar\\baz' );
// returns true
bool = isRelativePath.win32( 'C:\\foo\\..\\bar\\baz' );
// returns falseisRelativePath()is platform-specific. On Windows platforms, the function is equal toisRelativePath.win32(). On POSIX platforms, the function is equal toisRelativePath.posix().
var isRelativePath = require( '@stdlib/assert-is-relative-path' );
var bool = isRelativePath.posix( 'foo/' );
// returns true
bool = isRelativePath.posix( 'foo' );
// returns true
bool = isRelativePath.posix( '.' );
// returns true
bool = isRelativePath.posix( '' );
// returns true
bool = isRelativePath.posix( '/foo/bar/baz' );
// returns false
bool = isRelativePath.posix( '/foo/..' );
// returns false
bool = isRelativePath.win32( 'foo\\bar\\baz' );
// returns true
bool = isRelativePath.win32( 'foo/bar/baz' );
// returns true
bool = isRelativePath.win32( 'foo/..' );
// returns true
bool = isRelativePath.win32( '.' );
// returns true
bool = isRelativePath.win32( '' );
// returns true
bool = isRelativePath.win32( 'C:\\foo\\bar\\baz' );
// returns false
bool = isRelativePath.win32( '//server' );
// returns false
bool = isRelativePath.win32( '\\\\server' );
// returns false
bool = isRelativePath.win32( 'C:/foo/bar/baz' );
// returns false
bool = isRelativePath.win32( '/foo/..' );
// returns falseTo use the module as a general utility, install the module globally
npm install -g @stdlib/assert-is-relative-pathUsage: is-relative-path [options] [<path>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--platform name Platform: 'win32' or 'posix'.
$ is-relative-path ./foo/bar/baz --platform=posix
trueTo use as a standard stream,
$ echo -n './docs/repl.txt' | is-relative-path
true@stdlib/assert/is-absolute-path: test if a value is an absolute path.
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
See LICENSE.
Copyright © 2016-2022. The Stdlib Authors.
