Le module FileSystem (fs) est un module central de Node.js, offrant des capacités puissantes pour interagir avec les fichiers de manière programmatique. Ce module est utile dans diverses tâches, y compris la gestion des configurations, la gestion de l'organisation des données, et la lecture et l'écriture de contenu de fichiers.

📖 Lecture de fichier avec fs.readFile

La méthode fs.readFile renvoie une promesse qui se résout avec le contenu du fichier. Elle permet une lecture de fichier asynchrone, ce qui la rend adaptée à la lecture de fichiers texte et binaires.

fs.readFile(path, options)

• path - le chemin du fichier à lire ;
• options - un objet optionnel spécifiant des options comme l'encodage.

Imaginez construire une plateforme de blog dynamique. Ici, la méthode fs.readFile entre en scène, récupérant rapidement le contenu des articles de blog à partir d'un fichier.

Exemple de code : Lecture de contenu

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);
  });

Explication étape par étape

🖋️ Écriture de fichier avec fs.writeFile

La méthode fs.writeFile renvoie une promesse qui se résout lorsque le fichier a été écrit. Elle est utilisée pour écrire des données de manière asynchrone dans un fichier, qui peut être nouveau ou existant. Elle offre des options pour spécifier les données, l'encodage et les permissions du fichier.

fs.writeFile(file, data, options)

• file - le chemin du fichier à écrire ;
• data - les données à écrire, qui peuvent être une chaîne de caractères ou un tampon ;
• options - un objet optionnel spécifiant des options comme l'encodage et le mode du fichier.

Imaginez que nous devons enregistrer un nouvel utilisateur dans le fichier user-db.json. Ici, la méthode fs.writeFile garantit que nos mots trouvent leur place.

Exemple de code : Écriture de données utilisateur

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);
  });

Explication étape par étape

📄 Extension avec fs.appendFile

La méthode fs.appendFile retourne une promesse qui se résout lorsque les données ont été ajoutées au fichier. Elle est utilisée pour ajouter des données de manière asynchrone à un fichier existant, en préservant son contenu antérieur.

fs.appendFile(file, data, options)

• file - le chemin du fichier auquel les données seront ajoutées ;
• data - les données à ajouter, qui peuvent être une chaîne de caractères ou un tampon ;
• options - un objet optionnel spécifiant des options comme l'encodage et le mode du fichier.

Imaginez une application de chat animée enregistrant des conversations. Au fur et à mesure que de nouveaux messages arrivent, la méthode fs.appendFile ajoute de nouveaux messages au journal de chat tout en préservant les interactions antérieures.

Exemple de Code : Ajout de Messages de Chat

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);
  });

Explication étape par étape

Remarque

• fs.writeFile est utilisé pour remplacer complètement le contenu d'un fichier ou créer un nouveau fichier ;
• fs.appendFile est utilisé pour ajouter de nouvelles données à la fin d'un fichier existant sans écraser ce qui est déjà là.

🧐 Temps de Quiz

Évaluons votre compréhension des concepts du module FileSystem (fs):