📃 Table of Contents

• Features
• Usage
• API
• Examples
• Changelog
• Support
• License
• Related
• Author

🤖 Features

• 🌐 Detects UNC paths for both Windows and UNIX formats
• 🖥️ Extracts server and resource parts with named capture groups
• 📦 Returns a typed object with server and resource keys
• 🧩 Simple API with isValid() and parse() functions
• ⚡ Lightweight, zero‑dependency implementation
• 🛡️ Handles empty or invalid inputs gracefully
• 🔍 Uses clear, maintainable regular expressions
• 📝 TypeScript types for strong, predictable usage
• 🔄 Reusable patterns for consistent path parsing

🕵🏼 Usage

Install it by executing any of the following, depending on your preferred package manager:

pnpm add @igorskyflyer/unc-path

yarn add @igorskyflyer/unc-path

npm i @igorskyflyer/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

🗒️ Examples

import { isValid } from '@igorskyflyer/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 '@igorskyflyer/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: '',
      	}
*/

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

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

💖 Support

🧬 Related

@igorskyflyer/encode-entities

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

@igorskyflyer/regkeys

📚 An NPM package for fetching Windows registry keys. 🗝

@igorskyflyer/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(). 🧬

@igorskyflyer/is-rootdir

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

@igorskyflyer/valid-path

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

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).