Node.js File Paths

Article Authors
Table of Contents

Every file in the system has a path. On Linux and macOS, a path might look like: /users/joe/file.txt while Windows computers are different, and have a structure such as: C:\users\joe\file.txt

You need to pay attention when using paths in your applications, as this difference must be taken into account.

You include this module in your files using const path = require('path'); and you can start using its methods.

Getting information out of a path

Given a path, you can extract information out of it using those methods:

  • dirname: get the parent folder of a file
  • basename: get the filename part
  • extname: get the file extension

Example

JS

You can get the file name without the extension by specifying a second argument to basename:

JS

Working with paths

You can join two or more parts of a path by using path.join():

JS

You can get the absolute path calculation of a relative path using path.resolve():

JS

In this case Node.js will simply append /joe.txt to the current working directory. If you specify a second parameter folder, resolve will use the first as a base for the second:

JS

If the first parameter starts with a slash, that means it's an absolute path:

JS

path.normalize() is another useful function, that will try and calculate the actual path, when it contains relative specifiers like . or .., or double slashes:

JS

Neither resolve nor normalize will check if the path exists. They just calculate a path based on the information they got.