nsq/nsqadmin/node_modules/is-unc-path/README.md

is-unc-path

Returns true if a filepath is a windows UNC file path.

Install

Install with npm:

$ npm install --save is-unc-path

Usage

var isUncPath = require('is-unc-path');

true

Returns true for windows UNC paths:

isUncPath('\\/foo/bar');
isUncPath('\\\\foo/bar');
isUncPath('\\\\foo\\admin$');
isUncPath('\\\\foo\\admin$\\system32');
isUncPath('\\\\foo\\temp');
isUncPath('\\\\/foo/bar');
isUncPath('\\\\\\/foo/bar');

false

Returns false for non-UNC paths:

isUncPath('/foo/bar');
isUncPath('/');
isUncPath('/foo');
isUncPath('/foo/');
isUncPath('c:');
isUncPath('c:.');
isUncPath('c:./');
isUncPath('c:./file');
isUncPath('c:/');
isUncPath('c:/file');

Customization

Use .source to use the regex as a component of another regex:

var myRegex = new RegExp(isUncPath.source + 'foo');

Rules for UNC paths

• The computer name is always preceded by a double backward-slash (\\).
• UNC paths cannot contain a drive letter (such as D:)

Release history

v1.0.0 - 2017-07-12

Changes

• now throws a TypeError if value is not a string

About

Related projects

• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern… more | homepage
• is-relative: Returns true if the path appears to be relative. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on July 13, 2017.