De FileSystem-module (fs) is een kernmodule in Node.js en biedt krachtige mogelijkheden voor het programmatisch werken met bestanden. Deze module is nuttig voor diverse taken, waaronder het beheren van configuraties, het organiseren van gegevens en het lezen en schrijven van bestandsinhoud.

📖 Bestanden lezen met fs.readFile

De methode fs.readFile retourneert een promise die wordt opgelost met de inhoud van het bestand. Hiermee kan asynchroon een bestand worden gelezen, waardoor deze methode geschikt is voor het lezen van tekst- en binaire bestanden.

fs.readFile(path, options)

• path - het pad naar het te lezen bestand;
• options - een optioneel object met opties zoals de codering.

Stel je voor dat je een dynamisch blogplatform bouwt. Hier komt de methode fs.readFile in beeld, waarmee snel de inhoud van een blogpost uit een bestand wordt opgehaald.

Codevoorbeeld: Inhoud lezen

const fs = require('fs').promises;

fs.readFile('blog-post.txt', 'utf-8')
  .then(content => {
    console.log('Current content:', content);
  })
  .catch(err => {
    console.error('Error reading file:', err);
  });

Stapsgewijze uitleg

🖋️ Bestand schrijven met fs.writeFile

De methode fs.writeFile retourneert een promise die wordt vervuld wanneer het bestand is geschreven. Deze methode wordt gebruikt om asynchroon gegevens naar een bestand te schrijven, zowel nieuw als bestaand. Er zijn opties beschikbaar voor het specificeren van de gegevens, codering en bestandsrechten.

fs.writeFile(file, data, options)

• file - het pad naar het bestand waarin wordt geschreven;
• data - de te schrijven gegevens, dit kan een string of een buffer zijn;
• options - een optioneel object voor opties zoals codering en bestandsmodus.

Stel dat we een nieuwe gebruiker moeten opslaan in het bestand user-db.json. Hier zorgt de methode fs.writeFile ervoor dat onze gegevens worden opgeslagen.

Codevoorbeeld: Gebruikersgegevens schrijven

const fs = require("fs").promises;

const newUser = {
  id: 1,
  username: "Nero",
  email: "arman@example.com",
};

const fileName = "user-db.json";

fs.writeFile(fileName, JSON.stringify(newUser), "utf-8")
  .then(() => {
    console.log("User information saved successfully.");
  })
  .catch((err) => {
    console.error("Error writing file:", err);
  });

Stapsgewijze uitleg

📄 Uitbreiden met fs.appendFile

De methode fs.appendFile retourneert een promise die wordt vervuld wanneer de gegevens aan het bestand zijn toegevoegd. Deze methode wordt gebruikt om asynchroon gegevens toe te voegen aan een bestaand bestand, waarbij de eerdere inhoud behouden blijft.

fs.appendFile(file, data, options)

• file - het pad naar het bestand waaraan gegevens worden toegevoegd;
• data - de toe te voegen gegevens, dit kan een string of een buffer zijn;
• options - een optioneel object voor opties zoals codering en bestandsmodus.

Stel je een drukke chatapplicatie voor die gesprekken registreert. Terwijl nieuwe berichten binnenkomen, voegt de methode fs.appendFile deze toe aan het chatlogboek, terwijl eerdere interacties behouden blijven.

Codevoorbeeld: Chatberichten toevoegen

const fs = require("fs").promises;

const newMessage = "User2: Hello, how are you?";

fs.appendFile("chat.txt", newMessage + "\n")
  .then(() => {
    console.log("Message added to chat log.");
  })
  .catch((err) => {
    console.error("Error appending message:", err);
  });

Stapsgewijze Uitleg

Opmerking

• fs.writeFile wordt gebruikt om de inhoud van een bestand volledig te vervangen of een nieuw bestand aan te maken;
• fs.appendFile wordt gebruikt om nieuwe gegevens toe te voegen aan het einde van een bestaand bestand zonder de bestaande inhoud te overschrijven.

🧐 Quiz Tijd

Beoordeel uw begrip van de concepten van de FileSystem (fs) module: