About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isRelativePath
Test if a value is a relative path.
Installation
npm install @stdlib/assert-is-relative-path
Usage
var isRelativePath = require( '@stdlib/assert-is-relative-path' );
isRelativePath( value )
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
}
isRelativePath.posix( value )
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 false
isRelativePath.win32( value )
Tests 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 false
Notes
-
isRelativePath()
is platform-specific. On Windows platforms, the function is equal toisRelativePath.win32()
. On POSIX platforms, the function is equal toisRelativePath.posix()
.
Examples
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 false
See Also
-
@stdlib/assert-is-relative-path-cli
: CLI package for use as a command-line utility. -
@stdlib/assert-is-absolute-path
: test if a value is an absolute path.
Notice
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.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.