1 # is-unc-path [![NPM version](https://img.shields.io/npm/v/is-unc-path.svg?style=flat)](https://www.npmjs.com/package/is-unc-path) [![NPM monthly downloads](https://img.shields.io/npm/dm/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path) [![NPM total downloads](https://img.shields.io/npm/dt/is-unc-path.svg?style=flat)](https://npmjs.org/package/is-unc-path) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/is-unc-path.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/is-unc-path)
3 > Returns true if a filepath is a windows UNC file path.
7 Install with [npm](https://www.npmjs.com/):
10 $ npm install --save is-unc-path
16 var isUncPath = require('is-unc-path');
21 Returns true for windows UNC paths:
24 isUncPath('\\/foo/bar');
25 isUncPath('\\\\foo/bar');
26 isUncPath('\\\\foo\\admin
30 Returns false for non-UNC paths:
33 isUncPath('/foo/bar');
40 isUncPath('c:./file');
47 Use `.source` to use the regex as a component of another regex:
50 var myRegex = new RegExp(isUncPath.source + 'foo');
53 **[Rules for UNC paths](http://resources.esri.com/help/9.3/ArcGISDesktop/com/Gp_ToolRef/sharing_tools_and_toolboxes/pathnames_explained_colon_absolute_relative_unc_and_url.htm)**
55 * The computer name is always preceded by a double backward-slash (`\\`).
56 * UNC paths cannot contain a drive letter (such as `D:`)
62 * [dirname-regex](https://www.npmjs.com/package/dirname-regex): Regular expression for matching the directory part of a file path. | [homepage](https://github.com/regexps/dirname-regex "Regular expression for matching the directory part of a file path.")
63 * [dotdir-regex](https://www.npmjs.com/package/dotdir-regex): Regex for matching dot-directories, like `.git/` | [homepage](https://github.com/regexps/dotdir-regex "Regex for matching dot-directories, like `.git/`")
64 * [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex "Regular expresson for matching dotfiles.")
65 * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
66 * [is-unc-path](https://www.npmjs.com/package/is-unc-path): Returns true if a filepath is a windows UNC file path. | [homepage](https://github.com/jonschlinkert/is-unc-path "Returns true if a filepath is a windows UNC file path.")
67 * [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex "Regular expression for matching the parts of a file path.")
68 * [unc-path-regex](https://www.npmjs.com/package/unc-path-regex): Regular expression for testing if a file path is a windows UNC file path. Can… [more](https://github.com/regexhq/unc-path-regex) | [homepage](https://github.com/regexhq/unc-path-regex "Regular expression for testing if a file path is a windows UNC file path. Can also be used as a component of another regexp via the `.source` property.")
72 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
76 _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
78 To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
81 $ npm install -g verb verb-generate-readme && verb
86 Install dev dependencies:
89 $ npm install -d && npm test
96 * [github/jonschlinkert](https://github.com/jonschlinkert)
97 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
101 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
102 Released under the [MIT license](https://github.com/jonschlinkert/is-unc-path/blob/master/LICENSE).
106 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._
109 isUncPath('\\foo\admin$\system32');
110 isUncPath('\\foo\temp');
111 isUncPath('\\/foo/bar');
112 isUncPath('\\\/foo/bar');
117 Returns false for non-UNC paths:
120 isUncPath('/foo/bar');
127 isUncPath('c:./file');
129 isUncPath('c:/file');
134 Use `.source` to use the regex as a component of another regex:
137 var myRegex = new RegExp(isUncPath.source + 'foo');
140 **[Rules for UNC paths](http://resources.esri.com/help/9.3/ArcGISDesktop/com/Gp_ToolRef/sharing_tools_and_toolboxes/pathnames_explained_colon_absolute_relative_unc_and_url.htm)**
142 * The computer name is always preceded by a double backward-slash (`\\`).
143 * UNC paths cannot contain a drive letter (such as `D:`)
149 * [dirname-regex](https://www.npmjs.com/package/dirname-regex): Regular expression for matching the directory part of a file path. | [homepage](https://github.com/regexps/dirname-regex "Regular expression for matching the directory part of a file path.")
150 * [dotdir-regex](https://www.npmjs.com/package/dotdir-regex): Regex for matching dot-directories, like `.git/` | [homepage](https://github.com/regexps/dotdir-regex "Regex for matching dot-directories, like `.git/`")
151 * [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex "Regular expresson for matching dotfiles.")
152 * [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
153 * [is-unc-path](https://www.npmjs.com/package/is-unc-path): Returns true if a filepath is a windows UNC file path. | [homepage](https://github.com/jonschlinkert/is-unc-path "Returns true if a filepath is a windows UNC file path.")
154 * [path-regex](https://www.npmjs.com/package/path-regex): Regular expression for matching the parts of a file path. | [homepage](https://github.com/regexps/path-regex "Regular expression for matching the parts of a file path.")
155 * [unc-path-regex](https://www.npmjs.com/package/unc-path-regex): Regular expression for testing if a file path is a windows UNC file path. Can… [more](https://github.com/regexhq/unc-path-regex) | [homepage](https://github.com/regexhq/unc-path-regex "Regular expression for testing if a file path is a windows UNC file path. Can also be used as a component of another regexp via the `.source` property.")
159 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
163 _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
165 To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
168 $ npm install -g verb verb-generate-readme && verb
173 Install dev dependencies:
176 $ npm install -d && npm test
183 * [github/jonschlinkert](https://github.com/jonschlinkert)
184 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
188 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
189 Released under the [MIT license](https://github.com/jonschlinkert/is-unc-path/blob/master/LICENSE).
193 _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on December 07, 2016._