Node.js — Read a JSON File

JSON (JavaScript Object Notation) is a data format used across applications to share data. The applications can use different languages and they are able to share information using the JSON format.

Node.js and NPM use a JSON file storing configuration details: the package.json file. Besides the package.json file, you may interact with other JSON files located on your local disk. Node.js comes with built-in functionality to read and parse JSON files from your hard drive. Read on for more details!

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js (Coming soon)
  27. Check if a String is Empty in JavaScript or Node.js (Coming soon)
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js (Coming soon)
  29. Left-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  30. Right-Trim Characters Off a String in JavaScript or Node.js (Coming soon)
  31. Lowercase the First Character of a String in JavaScript or Node.js (Coming soon)
  32. Uppercase the First Character of a String in JavaScript or Node.js (Coming soon)
  33. Prepend Characters or Words to a String in JavaScript or Node.js (Coming soon)
  1. Get Number of Seconds Since Epoch in JavaScript
  2. Get Tomorrow’s Date in JavaScript
  3. Increase a Date in JavaScript by One Week
  4. Add Seconds to a Date in Node.js and JavaScript
  5. Add Month(s) to a Date in JavaScript or Node.js
  6. Add Week(s) to a Date in JavaScript or Node.js
  7. Get the Current Year in JavaScript or Node.js
  8. How to Get a UNIX Timestamp in JavaScript or Node.js
  9. How to Convert a UNIX Timestamp to a Date in JavaScript or Node.js
  10. Add Days to a Date in JavaScript or Node.js
  11. Get Yesterday's Date in JavaScript or Node.js
  12. Add Minutes to a Date in JavaScript or Node.js (Coming soon)
  13. Add Hours to a Date in JavaScript or Node.js (Coming soon)
  14. Check If a Date Is Today in JavaScript or Node.js (Coming soon)
  15. Check If a Date is Tomorrow in JavaScript or Node.js (Coming soon)
  16. Check If a Date is Yesterday in JavaScript or Node.js (Coming soon)
  17. How to Format a Date YYYY-MM-DD in JavaScript or Node.js (Coming soon)

Read and Parse a JSON File From Disk

Node.js provides the fs module to read files from the local hard disk. Use the Fs.readFile to read the content of a given file. Related to a JSON file, you’ll then have the JSON content as a string.

The next step is to parse the JSON string into a JavaScript value. Node.js provides the global JSON class for that. Use the JSON.parse method to convert the JSON string into a JavaScript object

Here’s a code sample reading the local package.json from the hard disk and parsing it into a usable JavaScript object:

const Fs = require('fs/promises')

const json = await Fs.readFile('./package.json')  
const package = JSON.parse(json)

package.version  
// 3.5.0

You can use the package object like you would use any other JavaScript object.

Read a JSON File Using require()

The CommonJS module loader comes with the require() function. It’s a global function that you typically use to import files within other files. A nice benefit of the require is that it can read and resolve JSON files, too. It loads the JSON file from disk and detects the need to parse it to a JavaScript object.

You can import a JSON file using the require from the CommonJS module loader like this:

const package = require('./package.json')

package.version  
// 3.5.0

Use the @supercharge/fs Package

I’m the maintainer of the @supercharge/fs package providing convenient file system utilities. The @supercharge/fs package comes with a handy Fs.readJson(path) method. the Fs.readJson method reads and parses the content of a JSON file and returns the resolved JavaScript value:

import Fs from '@supercharge/fs'

const package = await Fs.readJson('package.json')

package.version  
// 3.5.0

That’s it!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.