unc-path-regex

What is unc-path-regex?

The unc-path-regex npm package provides a regular expression specifically designed to match UNC (Universal Naming Convention) paths. UNC paths are used to specify the location of resources like files or devices on a network. This package is particularly useful for developers working with network file systems in Node.js applications, allowing them to validate and manipulate UNC paths efficiently.

What are unc-path-regex's main functionalities?

UNC Path Validation

This feature allows developers to validate if a given string is a UNC path. The provided code sample demonstrates how to use the unc-path-regex to test if specific paths are UNC paths.

const uncPathRegex = require('unc-path-regex');
const regex = uncPathRegex();
console.log(regex.test('\\\\Server01\\user\\docs\\Letter.txt')); // true
console.log(regex.test('C:\\path\\to\\file.txt')); // false

Extract UNC Path Components

This feature can be used to extract components of a UNC path using the regex match method. The code sample shows how to extract the full UNC path from a string.

const uncPathRegex = require('unc-path-regex');
const regex = uncPathRegex();
const uncPath = '\\\\Server01\\share\\file.txt';
const match = uncPath.match(regex);
console.log(match[0]); // '\\\\Server01\\share\\file.txt'

Other packages similar to unc-path-regex

path-regex

The path-regex package provides a regular expression to match and validate general file paths. Unlike unc-path-regex, which is specialized for UNC paths, path-regex handles a broader range of file paths including both Windows and POSIX formats.

is-unc-path

is-unc-path is a package that checks if a path is a UNC path. It provides a more focused approach similar to unc-path-regex but instead of providing a regex, it offers a function that returns a boolean indicating whether the path is a UNC path or not.

README

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.

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

---

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