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!
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 (see README). - If you are using Deno, visit the
denobranch (see README for usage intructions). - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch (see README). - To use as a general utility for the command line, install the corresponding CLI package globally.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
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 as a general utility, install the CLI package globally
npm install -g @stdlib/assert-is-relative-path-cliUsage: is-relative-path [options] [<path>]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--platform name Platform: 'win32' or 'posix'.
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'.
-
If the split separator is a regular expression, ensure that the
splitoption is either properly escaped or enclosed in quotes.# Not escaped... $ echo -n $'/foo/bar/baz\n./docs/repl.txt' | is-relative-path --split /\r?\n/ # Escaped... $ echo -n $'/foo/bar/baz\n./docs/repl.txt' | is-relative-path --split /\\r?\\n/
-
The implementation ignores trailing delimiters.
$ is-relative-path ./foo/bar/baz --platform=posix
trueTo use as a standard stream,
$ echo -n './docs/repl.txt' | is-relative-path
trueBy default, when used as a standard stream, the implementation assumes newline-delimited data. To specify an alternative delimiter, set the split option.
$ echo -n '/foo/bar/baz\t./docs/repl.txt' | is-relative-path --platform=posix --split '\t'
false
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-2024. The Stdlib Authors.
