Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

isAbsolutePath

Test if a value is an absolute path.

Usage

var isAbsolutePath = require( '@stdlib/assert/is-absolute-path' );

isAbsolutePath( value )

Tests if a value is an absolute path.

var IS_WINDOWS = require( '@stdlib/assert/is-windows' ); var bool; if ( IS_WINDOWS ) { bool = isAbsolutePath( 'C:\\foo\\bar\\baz' ); // returns true } else { bool = isAbsolutePath( '/foo/bar/baz' ); // returns true }

isAbsolutePath.posix( value )

Tests if a value is a POSIX absolute path.

var bool = isAbsolutePath.posix( '/foo/bar/baz' ); // returns true bool = isAbsolutePath.posix( 'foo/bar/baz' ); // returns false

isAbsolutePath.win32( value )

Tests if a value is a Windows absolute path.

var bool = isAbsolutePath.win32( 'C:\\foo\\bar\\baz' ); // returns true bool = isAbsolutePath.win32( 'foo\\bar\\baz' ); // returns false

Notes

  • isAbsolutePath() is platform-specific. On Windows platforms, the function is equal to isAbsolutePath.win32(). On POSIX platforms, the function is equal to isAbsolutePath.posix().

Examples

var isAbsolutePath = require( '@stdlib/assert/is-absolute-path' ); var bool = isAbsolutePath.posix( '/foo/bar/baz' ); // returns true bool = isAbsolutePath.posix( '/foo/..' ); // returns true bool = isAbsolutePath.posix( 'foo/' ); // returns false bool = isAbsolutePath.posix( 'foo' ); // returns false bool = isAbsolutePath.posix( '.' ); // returns false bool = isAbsolutePath.posix( '' ); // returns false bool = isAbsolutePath.win32( 'C:\\foo\\bar\\baz' ); // returns true bool = isAbsolutePath.win32( '//server' ); // returns true bool = isAbsolutePath.win32( '\\\\server' ); // returns true bool = isAbsolutePath.win32( 'C:/foo/bar/baz' ); // returns true bool = isAbsolutePath.win32( '/foo/..' ); // returns true bool = isAbsolutePath.win32( 'foo\\bar\\baz' ); // returns false bool = isAbsolutePath.win32( 'foo/bar/baz' ); // returns false bool = isAbsolutePath.win32( 'foo/..' ); // returns false bool = isAbsolutePath.win32( '.' ); // returns false bool = isAbsolutePath.win32( '' ); // returns false

CLI

Usage

Usage: is-absolute-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/'. 

Notes

  • If the split separator is a regular expression, ensure that the split option is either properly escaped or enclosed in quotes.

    # Not escaped... $ echo -n $'/foo/bar/baz\n./docs/repl.txt' | is-absolute-path --split /\r?\n/ # Escaped... $ echo -n $'/foo/bar/baz\n./docs/repl.txt' | is-absolute-path --split /\\r?\\n/
  • The implementation ignores trailing delimiters.

Examples

$ is-absolute-path /foo/bar/baz --platform=posix true

To use as a standard stream,

$ echo -n './docs/repl.txt' | is-absolute-path false

By 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-absolute-path --platform=posix --split '\t' true false

See Also