Reading and Writing Files With NodeJS

#file system

Elliot Forbes ⏰ 3 Minutes 📅 Apr 15, 2017

In this tutorial I’m going to be showing you exactly how we can read and write files on our local filesystem using NodeJS.

Reading From Files

Being able to read from files on your local file system can be hugely useful and there are a number of different things you can build on top of this. A log reader, importing information from spreadsheets and xml files or whatever you can think of, being able to read from files is hugely useful.

The FS Package

Create a new file called app.js and add the following:

app.js

var fs = require("fs");

fs.readFile("temp.txt", function(err, buf) {
  console.log(buf.toString());
});

Create a temp.txt within the same directory and write in it anything you’d like. Run your script using node app.js and you should see in the console the contents of your file.

Understanding the Code

We’ll step through this with comments.

var fs = require("fs");

This line does the job of importing the fs package and allowing us to utilize it within our own code.

fs.readFile("temp.txt", function(err, buf) {
  console.log(buf);
});

This calls the readFile function asynchronously and then prints the contents of the file to the console.

Handling Errors

If you want to catch errors such as the file you are trying to reach isn’t found, then you can do so like this:

fs.readFile("not-found.txt", "utf-8", (err, data) => {
    if (err) { console.log(err) }
    console.log(data);
})

When you go to execute this, you should see something like this returned:

$ node app.js

{ Error: ENOENT: no such file or directory, open 'not-found.txt'
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: 'not-found.txt' }
undefined

Returning a Buffer?

If the above code hasn’t worked as expected and you are seeing a buffer being printed out in the terminal then it might be an idea to specify the files encoding. We can do this like so:

var fs = require("fs");

fs.readFile("temp.txt", "utf-8", (err, data) => {
  console.log(data);
});

Writing To Files

Now that you’ve got the reading of files down, it’s time to start modifying these files. To do this we’ll be using the same FS package we used in part one.

The Code:

Again create a new file within your current directory and call it write.js and then add the following javascript code:

write.js

var fs = require("fs");

var data = "New File Contents";

fs.writeFile("temp.txt", data, (err) => {
  if (err) console.log(err);
  console.log("Successfully Written to File.");
});

Run this code by executing node write.js in the terminal and then open up temp.txt in your editor, you should now see the new contents of the file.

Creating New Files - The above code will successfully create new files for you should the path to the file not already exist. This is handy as it means you can succinctly create, and write to a new file in one promise.

Conclusion

Hopefully you found this tutorial useful, if you did, or if you have any suggestions or comments, then please let me know in the comments section below!