@stdlib/assert-is-absolute-path
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    isAbsolutePath

    NPM version Build Status Coverage Status dependencies

    Test if a value is an absolute path.

    Installation

    npm install @stdlib/assert-is-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

    Installation

    To use the module as a general utility, install the module globally

    npm install -g @stdlib/assert-is-absolute-path

    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'.
    

    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

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2021. The Stdlib Authors.

    Install

    npm i @stdlib/assert-is-absolute-path

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    28

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    46.6 kB

    Total Files

    13

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser