patha

File paths library. All you need to work with paths. Tiny drop-in replacement for 'path'. Works in Node, Browser, and Deno.

• Install
• Usage
• API
  • addExeExt (function)
  • addNamePrefix (function)
  • addNameSuffix (function)
  • addShExt (function)
  • addShRelativePrefix (function)
  • name (function)
  • normalizeTrim (function)
  • removeExt (function)
  • replaceExt (function)
  • isPathInside (function)
• 🤝 Contributing

Install

1npm install --save patha

patha is tiny and treeshakable.

Usage

Automatic (depends on your build system)

1import * as patha from "patha"

Node

1import * as patha from "patha/dist/index.node.mjs"

Node CJS

1const patha = require("patha/dist/index.node.cjs")

Browser

1import * as patha from "patha/dist/index.browser.mjs"

Browser Legacy

1import * as patha from "patha/dist/index.browser.legacy.js"

Deno

1import * as patha from "patha/dist/index.deno.mjs"

API

patha is a drop-replacement for path, which is explained in the Nodejs documentation.

1import {
2  basename,
3  delimiter,
4  dirname,
5  extname,
6  format,
7  isAbsolute,
8  join,
9  normalize,
10  parse,
11  posix,
12  relative,
13  resolve,
14  sep,
15  toNamespacedPath,
16  win32,
17} from "patha"

Additionally, patha supports the following functions:

addExeExt (function)

Add bin extension to the given binary name.

Parameters:

• name (string) - The name you want to add the shell extension to
• win_ext (string) - Defaults to .exe on Windows
• other_ext (string) - Defaults to "" On other platforms.

returns: string

1import { addExeExt } from "patha"
2
3addExeExt("path/to/file-name") // gives "path/to/file-name.exe" on Windows and "path/to/file-name" on others

addNamePrefix (function)

Adds a prefix to the start of the name of the given path

Parameters:

• path (string) - The given file path
• prefix (string) - The prefix to add to the start of the file name

returns: string

1import { addNamePrefix } from "patha"
2
3addNamePrefix("path/to/file-name.ext", "new-") // gives "path/to/new-file-name.ext"

addNameSuffix (function)

Adds a suffix to the end of the name of the given path

Parameters:

• path (string) - The given file path
• suffix (string) - The suffix to add to the end of the file name

returns: string

1import { addNameSuffix } from "patha"
2
3addNameSuffix("path/to/file-name.ext", "-old") // gives "path/to/file-name-old.ext"
4
5addNameSuffix("path/to/file-name.ext", ".test") // gives "path/to/file-name.test.ext"

addShExt (function)

Add a native shell extension to the given name.

Parameters:

• name (string) - The name you want to add the shell extension to
• win_ext (string) - .cmd on Windows
• other_ext (string) - .sh On others.

returns: string

1import { addShExt } from "patha"
2
3addShExt("path/to/file-name") // gives "path/to/file-name.cmd" on Windows and "path/to/file-name.sh" on others
4
5addShExt("path/to/file-name", ".bat") // gives "path/to/file-name.bat" on Windows and "path/to/file-name.sh" on others

addShRelativePrefix (function)

Prefix a ./ for unix shell and nothing for cmd.

Parameters:

• path (string) - The given path

returns: string

1import { addShRelativePrefix } from "patha"
2
3addShRelativePrefix("some/file-name") // gives "some/file-name" on Windows and "./some/file-name" on others.

name (function)

Get the name of the given file path.

By default the file extension is included in the returned name. To remove the extension, set the second parameter to false.

Parameters:

• path (string) - The given file path
• includeExtension (boolean) - If the name should include the file extension as well

returns: string

1import { name } from "patha"
2
3name("path/to/file.md") // gives "file.md"
4
5name("path/to/file.md", false) // gives "file"

normalizeTrim (function)

Normalizes the path and removes the trailing slashes.

Parameters:

• path (string) - The given file path

returns: string

1import { normalize, normalizeTrim } from "patha"
2
3normalizeTrim("/foo/bar//baz/asdf/hello/../") // gives "/foo/bar/baz/asdf"
4
5normalize("/foo/bar//baz/asdf/hello/../") // gives "/foo/bar/baz/asdf/"

removeExt (function)

Remove a path's extension.

Parameters:

• path (string) - The given path

returns: string

1import { removeExt } from "patha"
2
3removeExt("some/dir/file.ext") // gives "some/dir/file"

replaceExt (function)

Replaces the extension from path with extension and returns the updated path string.

Does not replace the extension if path is not a string or is empty.

Parameters:

• path (string) - The given path
• extension (string) - The extension to replace

returns: any

1import { replaceExt } from "patha"
2
3replaceExt("path/to/file.md", ".html") // gives "path/to/file.html"

isPathInside (function)

Check if a path is inside another path.

Note that relative paths are resolved against process.cwd() to make them absolute.

This function does not check if the paths exist and it only works with strings.

Parameters:

• childPath (string)
• parentPath (string)

returns: boolean

1import { isPathInside } from "patha"
2
3isPathInside("a/b/c", "a/b")
4//=> true
5
6isPathInside("a/b/c", "x/y")
7//=> false
8
9isPathInside("a/b/c", "a/b/c")
10//=> false
11
12isPathInside("/Users/some/dev/aa", "/Users/some")
13//=> true

🤝 Contributing

You can sponsor my work here:

https://github.com/sponsors/aminya

Pull requests, issues and feature requests are welcome. See the Contributing guide.