@igor.dvlpr/unc-path v3.0.0

UNC Path

🥽 Provides ways of parsing UNC paths and checking whether they are valid. 🎱

🕵🏼 Usage

Install it by executing:

npm i "@igor.dvlpr/unc-path"

🤹🏼 API

isValid() => returns whether the given path is a UNC one.

Signature

isValid(path): boolean

Parameters

path: string // a string that represents the path to process

Example

import { isValid } from '@igor.dvlpr/unc-path'

console.log(isValid('//ComputerName/SharedFolder/')) // returns true
console.log(isValid('//ComputerName/SharedFolder/file.mp4')) // returns true
console.log(isValid('/ComputerName/SharedFolder/')) // returns false

parse() => parses the provided UNC path and returns UNC path's components as

{
	'server': string,
	'resource': string
}

Signature

parse(path): Object

Parameters

path: string // a string that represents the path to process

Example

import { parse } from '@igor.dvlpr/unc-path'

console.log(parse('//Server/Dev/file.js'))
/*
returns {
      		server: 'Server',
        	resource: '/Dev/file.js',
      	}
*/

console.log(parse('/Server/Dev/file.js'))
/*
returns {
      		server: '',
       		resource: '',
      	}
*/

🪪 License

Licensed under the MIT license which is available here, MIT license.

🧬 Related

@igor.dvlpr/encode-entities

🏃‍♂️ Fast and simple Map and RegExp based HTML entities encoder. 🍁

@igor.dvlpr/regkeys

📚 An NPM package for fetching Windows registry keys. 🗝

@igor.dvlpr/upath

🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬

@igor.dvlpr/is-rootdir

🔼 Provides a way to check if the given path is the root drive/directory. ⛔

@igor.dvlpr/valid-path

🧰 Provides ways of testing whether a given value can be a valid file/directory name. 🏜

Provided by Igor Dimitrijević (@igorskyflyer).