Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 2.52 KB

README.md

File metadata and controls

88 lines (61 loc) · 2.52 KB
Raw

unc-path-regex NPM version Build Status

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.

Visit the MSDN reference for Common Data Types 2.2.57 UNC for more information about UNC paths.

Install

Install with npm

$ npm i unc-path-regex --save

Usage

// unc-path-regex returns a function
var regex = require('unc-path-regex')();

true

Returns true for windows UNC paths:

regex.test('\\/foo/bar');
regex.test('\\\\foo/bar');
regex.test('\\\\foo\\admin$');
regex.test('\\\\foo\\admin$\\system32');
regex.test('\\\\foo\\temp');
regex.test('\\\\/foo/bar');
regex.test('\\\\\\/foo/bar');

false

Returns false for non-UNC paths:

regex.test('/foo/bar');
regex.test('/');
regex.test('/foo');
regex.test('/foo/');
regex.test('c:');
regex.test('c:.');
regex.test('c:./');
regex.test('c:./file');
regex.test('c:/');
regex.test('c:/file');

Related projects

  • dotfile-regex: Regular expresson for matching dotfiles.
  • dotdir-regex: Regex for matching dot-directories, like .git/
  • dirname-regex: Regular expression for matching the directory part of a file path.
  • is-unc-path: Returns true if a filepath is a windows UNC file path.
  • is-glob: Returns true if the given string looks like a glob pattern.
  • path-regex: Regular expression for matching the parts of a file path.

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on July 07, 2015.