Szybka pomoc

Ściągawka z modułu fs w Node.js

Szybki przewodnik po Node.js fs: asynchroniczny i synchroniczny odczyt, zapis, śledzenie zmian, metadane plików i operacje na katalogach.

· Opublikowano

Moduł fs (File System) w Node.js udostępnia API do pracy z lokalnym systemem plików przy użyciu Obietnic (Promises), wywołań zwrotnych lub synchronicznie.

API Oparte na Obietnicach (fs/promises)

const fs = require('fs/promises');
// import fs from 'node:fs/promises';

// Odczyt pliku jako ciąg znaków UTF-8
const content = await fs.readFile('data.txt', 'utf8');

// Zapis lub nadpisanie zawartości pliku
await fs.writeFile('output.txt', 'Hello World', 'utf8');

// Dopisanie danych na końcu pliku
await fs.appendFile('log.txt', 'New entry\n', 'utf8');

// Sprawdzenie istnienia i uprawnień dostępu
try {
  await fs.access('config.json');
} catch {
  console.log('Plik nie istnieje lub brak dostępu');
}

Synchroniczne API

const fs = require('fs');

const data = fs.readFileSync('input.txt', 'utf8');
fs.writeFileSync('output.txt', data);
fs.appendFileSync('output.txt', '\nappended');

const exists = fs.existsSync('file.txt');

Metadane i Statystyki Plików (fs.stat)

const stats = await fs.stat('file.txt');

stats.isFile();            // -> zwykły plik (true / false)
stats.isDirectory();       // -> katalog (true / false)
stats.isSymbolicLink();    // -> dowiązanie symboliczne (true / false)
stats.size;                // Rozmiar pliku w bajtach
stats.mtime;               // Znacznik czasu ostatniej modyfikacji

Operacje na Katalogach

// Wyświetlanie zawartości katalogu
const files = await fs.readdir('src/');

// Rekurencyjne tworzenie katalogów
await fs.mkdir('build/assets/css', { recursive: true });

// Rekurencyjne usuwanie katalogów
await fs.rm('dist/', { recursive: true, force: true });

Śledzenie Zmian w Systemie Plików (fs.watch)

const fs = require('fs');

const watcher = fs.watch('src/', { recursive: true }, (eventType, filename) => {
  console.log(`Event: ${eventType} on ${filename}`);
});

// Zatrzymanie obserwacji
watcher.close();

Deskryptory Plików (File Descriptors)

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

// Otwarcie tylko do odczytu
const filehandle = await fs.open('archive.bin', 'r');

// Alokacja bufora 1024 bajtów
const buffer = Buffer.alloc(1024);

// Odczyt bajtów do bufora
const { bytesRead } = await filehandle.read(buffer, 0, 1024, 0);

await filehandle.close();

Materiały Źródłowe

Powiązane tematy