time-to-botec/squiggle/node_modules/@stdlib/assert/is-unc-path/README.md

isUNCPath

Test if a value is a UNC path.

Usage

var isUNCPath = require( '@stdlib/assert/is-unc-path' );

isUNCPath( value )

Tests if a value is a UNC path.

var bool = isUNCPath( '\\\\server\\share\\foo\\bar\\baz' );
// returns true

bool = isUNCPath( '/foo/bar/baz' );
// returns false

Examples

var isUNCPath = require( '@stdlib/assert/is-unc-path' );

var bool;
var path;

path = '\\\\server\\share\\foo\\bar\\baz:a:b';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share\\foo\\bar\\baz::b';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share\\foo\\bar\\baz:a';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share\\foo\\bar\\baz';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share\\foo\\bar';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share\\foo';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\share';
bool = isUNCPath( path );
// returns true

path = '\\\\server\\\\share';
bool = isUNCPath( path );
// returns false

path = '\\\\\\\\server\\share';
bool = isUNCPath( path );
// returns false

path = 'beep boop \\\\server\\share';
bool = isUNCPath( path );
// returns false

path = '\\\\server';
bool = isUNCPath( path );
// returns false

path = '\\';
bool = isUNCPath( path );
// returns false

path = '';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\foo\\bar\\baz:';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\foo\\bar\\baz:a:';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\foo\\bar\\baz::';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\foo\\bar\\baz:a:b:c';
bool = isUNCPath( path );
// returns false

path = '\\\\server\\share\\foo\\bar\\';
bool = isUNCPath( path );
// returns false

path = '//server/share';
bool = isUNCPath( path );
// returns false

path = '/foo/bar';
bool = isUNCPath( path );
// returns false

path = 'foo/bar';
bool = isUNCPath( path );
// returns false

path = './foo/bar';
bool = isUNCPath( path );
// returns false

path = '/foo/../bar';
bool = isUNCPath( path );
// returns false

---

CLI

Usage

Usage: is-unc-path [options] [<path>]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ is-unc-path '\\\\server\\share\\foo'
true

To use as a standard stream,

$ echo -n '\\\\server\\share\\foo' | is-unc-path
true