Node.js Path Module Complete Reference
Last Updated :
07 Dec, 2022
Improve
The Path Module in Node.js provides the utilities for working with file and directory paths.
Example:
// Import the path module
const path = require('path');
// CASE 1
// If "dir", "root" and "base" are all given,
// "root" is ignored.
let path1 = path.format({
root: "C:\\ignored\\root",
dir: "website\\dist",
base: "index.html",
});
console.log("Path 1:", path1);
// CASE 2
// If "dir" is not specified then "root"
// will be used
// If only "root" is provided platform
// separator will not be included.
// "ext" will be ignored.
let path2 = path.format({
root: "C:\\",
base: "style.css",
ext: ".ignored",
});
console.log("Path 2:", path2);
// CASE 3
// If "base" is not specified
// "name" and "ext" will be used
let path3 = path.format({
root: "website\\",
name: "main",
ext: ".js",
});
console.log("Path 3:", path3);
Output:
Path 1: website\dist\index.html Path 2: C:\style.css Path 3: website\main.js
The Complete List of Path are listed below:
Node.js Path Module Methods | Description |
|---|---|
| Node.js path.basename() Method | This is used to get the filename portion of a path to the file. |
| Node.js path.dirname() Method | This is used to get the directory name of the given path. |
| Node.js path.extname() Method | This is used to get the extension portion of a file path. |
| Node.js path.format() Method | This is used to return a path string from the given path object. |
| Node.js path.isAbsolute() Method | This is used to check whether the given path is an absolute path or not. |
| Node.js path.join() Method | This is used to join a number of path segments using the platform-specific delimiter to form a single path. |
| Node.js path.normalize() Method | This is used to normalize the given path. |
| Node.js path.parse() Method | This s used to return an object whose properties represent the given path. |
| Node.js path.relative() Method | This is used to find the relative path from a given path to another path based on the current working directory. |
| Node.js path.resolve() Method | This is used to resolve a sequence of path segments to an absolute path. |
| Node.js path.toNamespacedPath() Method | This is used to find the equivalent namespace-prefixed path from the given path. |
Node.js Path Module Properties | Description |
|---|---|
| Node.js path.delimiter Property | This is used to get platform-specific path delimiter. |
