Node.js File System Operations

When you read a file, Node.js returns the data as a "Buffer" (raw binary data) by default. To make this data human-readable, you must specify an encoding, typically 'utf8'.

Implementation Example

In a web server environment (like Express), you might create an API endpoint to serve file content to a frontend application.

const filePath = 'message.txt';

app.get('/api/readFile', async (req, res) => {
  try {
    // We use 'utf8' to ensure the data is returned as a string, not a Buffer
    const data = await fs.readFile(filePath, 'utf8');
    res.json(data);
  } catch (err) {
    console.error('Error reading file:', err);
    res.status(500).send('Error reading file');
  }
});

Writing Files with writeFile()

If you need to create a new file or completely replace the contents of an existing one, you use the fs.writeFile() method.

Warning: The writeFile() method is destructive. If the file specified already exists, its previous content will be completely overwritten by the new data you provide.

Implementation Example

This is often used in POST requests where a user submits new information that needs to be saved to the server.

app.post('/api/writeFile', async (req, res) => {
  try {
    // req.body.content contains the new data sent from the client
    await fs.writeFile(filePath, req.body.content, 'utf8');
    res.send('File written successfully');
  } catch (err) {
    console.error('Error writing file:', err);
    res.status(500).send('Error writing file');
  }
});

Appending Files with appendFile()

There are many scenarios where you do not want to overwrite a file, but rather add new information to the end of it—such as adding a new entry to a log file. For this purpose, Node.js provides the fs.appendFile() method.

Unlike writeFile(), appendFile() preserves the existing data and simply attaches the new content to the bottom of the file.

Implementation Example

app.post('/api/appendFile', async (req, res) => {
  try {
    // This adds the new content to the end of the existing file
    await fs.appendFile(filePath, req.body.content, 'utf8');
    res.send('Content appended successfully');
  } catch (err) {
    console.error('Error appending to file:', err);
    res.status(500).send('Error appending to file');
  }
});

Summary Table of Operations

Practical Application: Recipe Manager

To practice these concepts, consider building a Recipe Manager application. In this project:

1. Users can Write a new recipe to a text file.
2. Users can Append notes or ingredients to an existing recipe file.
3. Users can Read the recipe file to display the instructions on their screen.

By mastering these three core operations, you gain the ability to manage persistent data, which is a cornerstone of modern software engineering.