📃 Table of Contents

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

🤖 Features

• 🖥️ Cross‑platform paths - Works seamlessly on Windows and UNIX‑like systems
• 🔄 Auto‑slash handling - Normalizes / and \ based on OS or target platform
• 📂 UNC path support - Detects and correctly formats network paths
• ➕ Optional trailing slash - Add it only when you need it
• ⚡ Cached regex - Faster repeated path splitting
• 🪞 Aliases for brevity - u() for upath() convenience
• 🎯 Force‑platform modes - uw() for Windows, ux() for UNIX regardless of host
• 🧹 Empty‑safe - Returns an empty String for invalid or empty input
• 🛠️ Single transform core - All functions share one clean, reusable logic

💡 TIP

WHY uPath?

Simple. Working with file paths inside Strings in Windows + JavaScript is a hassle. By calling u(), the file path you provided is converted to your OS-preferred file path format, i.e. you can get away with writing "C:/Users/JohnDoe/" without having to worry about those backslashes that Windows uses. On the other hand, UNIX-like slashes in file paths are left as-is. An extra feature that uPath provides is redundant trailing slash removal.*

ℹ️ NOTE

✨ Since version 1.2.0 support for UNC paths has been added, thanks to unc-path.

🕵🏼 Usage

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

pnpm add @igorskyflyer/upath

yarn add @igorskyflyer/upath

npm i @igorskyflyer/upath

🤹🏼 API

upath() => returns a proper file path depending on the host OS.

ℹ️ NOTE

upath() has an alias, named u() for your convenience.

Signature

upath(fsPath: string, addTrailingSlash: boolean = false): string

u(fsPath: string, addTrailingSlash: boolean = false): string

Parameters

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

addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not

Example - Windows OS

import { u } from '@igorskyflyer/upath'

console.log(u('C:/')) // returns 'C:\\'
console.log(u('C:/WINDOWS//////')) // returns 'C:\\WINDOWS\\'
console.log(u('C:/Users', true)) // returns 'C:\\Users\\'
console.log(u('\\\\ComputerName\\SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'
console.log(u('//ComputerName/SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'

Example - UNIX-like OS

import { u } from '@igorskyflyer/upath'

console.log(u('/mnt/')) // returns '/mnt/'
console.log(u('/usr/bin/////////')) // returns '/usr/bin/'
console.log(u('/usr/bin', true)) // returns '/usr/bin/'
console.log(u('//ComputerName/SharedFolder')) // returns '//ComputerName/SharedFolder'
console.log(u('\\\\ComputerName\\SharedFolder')) // returns '//ComputerName/SharedFolder'

uw() => returns a proper file path for Windows operating system.

Signature

uw(fsPath: string, addTrailingSlash: boolean = false): string

Parameters

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

addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not

Example - Any OS

import { uw } from '@igorskyflyer/upath'

console.log(uw('C:/WINDOWS/System32')) // returns 'C:\\WINDOWS\\System32'
console.log(uw('//ComputerName/SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'

ux() => returns a proper file path for UNIX-like operating systems.

Signature

ux(fsPath: string, addTrailingSlash: boolean = false): string

Parameters

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

addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not

Example - Any OS

import { ux } from '@igorskyflyer/upath'

console.log(ux('/usr/local')) // returns '/usr/local'
console.log(ux('\\\\ComputerName\\SharedFolder'))
// returns '//ComputerName/SharedFolder'

💡 TIP

Since v.1.0.3 a string property named slash is exposed as well, provides an easy way to access file path OS-specific delimiter.

On Windows slash = '\\'.

On UNIX-like slash = '/'.

📝 Changelog

📑 The changelog is available here, CHANGELOG.md.

🪪 License

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

💖 Support

🧬 Related

@igorskyflyer/duoscribi

✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓

@igorskyflyer/node-clone-js

🧬 A lightweight JavaScript utility allowing deep copy-by-value of nested objects, arrays and arrays of objects. 🪁

@igorskyflyer/str-is-in

🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍

@igorskyflyer/odin

🔱 Odin is an Object wrapper that allows you to create objects and set their attributes - all at once! 🔺

@igorskyflyer/mp3size

🧮 Calculates an estimated file size of Mp3 files. 🎶

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).