path_readme.md

Overview

path.mjs provides functions for FS paths. Features:

• Various common operations such as path joining, relativity, getting dirname / filename / extension, and more.
• Only string operations, no IO.
• OS-agnostic.
  • Supports Windows volumes.
  • Always normalizes \ to /.
• Tiny, no external dependencies.
• Can be customized via subclassing.

Known limitations:

• Insufficient documentation.
• Immature. Tests may be incomplete.
• Performance has not been optimized.

TOC

• #Overview
• #Usage
• #API
  • #Undocumented

Usage

Using a specific implementation:

import * as pt from 'https://cdn.jsdelivr.net/npm/@mitranim/js@0.1.85/path.mjs'

console.log(pt.join(`one`, `two`, `three.four`))
// 'one/two/three.four'

console.log(pt.dir(`one/two/three.four`))
// 'one/two'

console.log(pt.name(`one/two/three.four`))
// 'three.four'

console.log(pt.stem(`one/two/three.four`))
// 'three'

API

Undocumented

The following APIs are exported but undocumented. Check path.mjs.

• const SEP_WINDOWS
• const SEP_POSIX
• const SEP_ENV
• const EXT_SEP
• const CWD_REL
• const PAR_REL
• function toPosix
• function toWindows
• function norm
• function clean
• function isRoot
• function isCwdRel
• function isAbs
• function isRel
• function isRelExplicit
• function isRelImplicit
• function isDirLike
• function join
• function isSubOf
• function strictRelTo
• function relTo
• function dirLike
• function dir
• function volume
• function hasVolume
• function name
• function ext
• function hasExt
• function stem
• function replaceSep
• class Paths
• default paths