Socket
Socket
Sign inDemoInstall

unc-path-regex

Package Overview
Dependencies
0
Maintainers
2
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    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.


Version published
Weekly downloads
6.3M
decreased by-1.24%
Maintainers
2
Install size
5.58 kB
Created
Weekly downloads
 

Package description

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

Readme

Source

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');
  • 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.

Keywords

FAQs

Last updated on 10 Apr 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc