API-Referenz zu node:fs

Elide stellt node:fs, node:fs/promises, fs.promises und den Alias elide:fs bereit. Die folgenden Beispiele behandeln synchrone Operationen, Promises, FileHandle und Streams.

Grundlegende Verwendung

import fs from "node:fs";
import os from "node:os";
import path from "node:path";

const dir = fs.mkdtempSync(path.join(os.tmpdir(), "elide-fs-"));
const file = path.join(dir, "hello.txt");

try {
  fs.writeFileSync(file, "hello\n");
  console.log(fs.readFileSync(file, "utf8"));
  console.log(fs.statSync(file).isFile());
} finally {
  fs.rmSync(dir, { recursive: true, force: true });
}

Dieses Beispiel prüft mkdtempSync, writeFileSync, readFileSync, statSync und rmSync. Dateisystemfehler können die Felder code, errno, syscall, path und dest tragen.

Promises und Datei-Handles

import os from "node:os";
import path from "node:path";
import { mkdtemp, open, rm, writeFile } from "node:fs/promises";

const dir = await mkdtemp(path.join(os.tmpdir(), "elide-fs-"));
try {
  const file = path.join(dir, "data.txt");
  await writeFile(file, "hello\n");

  const handle = await open(file, "r");
  try {
    const buffer = Buffer.alloc(64);
    const { bytesRead } = await handle.read(buffer, 0, buffer.length, 0);
    console.log(buffer.subarray(0, bytesRead).toString());
  } finally {
    await handle.close();
  }
} finally {
  await rm(dir, { recursive: true, force: true });
}

Dieses Beispiel prüft die Promise-basierten Funktionen mkdtemp, writeFile, open und rm sowie FileHandle.read() und FileHandle.close(). Repräsentative Promise-Fehler stellen dieselben Felder im Node-Stil bereit wie oben beschrieben.

writeFile (und FileHandle.writeFile) akzeptieren außerdem ein synchrones oder asynchrones Iterable aus Strings und Buffern, einschließlich eines Readable-Streams:

import { writeFile } from "node:fs/promises";
import { Readable } from "node:stream";

await writeFile("out.txt", Readable.from(["a", "b", "c"]));

Streams

createReadStream und createWriteStream geben Readable- und Writable-Streams zurück. Das folgende geprüfte Beispiel kopiert eine temporäre Datei:

import fs from "node:fs";
import os from "node:os";
import path from "node:path";
import { pipeline } from "node:stream/promises";

const dir = fs.mkdtempSync(path.join(os.tmpdir(), "elide-fs-"));
try {
  const input = path.join(dir, "input.log");
  const output = path.join(dir, "copy.log");
  fs.writeFileSync(input, "first\nsecond\n");

  await pipeline(fs.createReadStream(input), fs.createWriteStream(output));
  console.log(fs.readFileSync(output, "utf8"));
} finally {
  fs.rmSync(dir, { recursive: true, force: true });
}

Überwachung

watch, watchFile, unwatchFile und die Promise-basierte Überwachung sind vorhanden. Ein offener Watcher hält das Skript am Leben, bis er geschlossen wird:

import fs from "node:fs";

const watcher = fs.watch(".", (event, name) => {
  console.log(event, name); // rename new.txt
  watcher.close();
});
setTimeout(() => fs.writeFileSync("new.txt", "hello"), 100);

fs.openAsBlob ist nicht verfügbar.

Sandbox

Der Dateisystemzugriff ist uneingeschränkt, bis Sandbox-Flags angegeben werden:

• --sandbox
• --allow-read[=PATHS]
• --allow-write[=PATHS]
• --fs-audit

Bei aktiver Sandbox schlagen verweigerte Operationen fehl, statt auf den Pfad zuzugreifen. Vorrang der Flags und Syntax von Pfadlisten finden Sie unter elide help sandbox.

Die üblichen Argumentformen finden Sie in der Node.js-Dokumentation zu fs.

Reference

Status: Partial · 246 of 264 suite tests pass (93.2%) · since 1.1.0

Exports

fs/promises

Not implemented

FileReadStream, FileWriteStream, Utf8Stream, lchmod, lchmodSync, openAsBlob.

Tests: node-api node:fs: 246 pass, 18 fail, 0 error, 30 skipped. Failing: test-fs-promises-file-handle-pull.js, test-fs-promises-file-handle-pullsync.js, test-fs-promises-file-handle-read-worker.js, test-fs-promises-file-handle-writer.js, test-fs-promises-watch.js, test-fs-promises.js, test-fs-read-stream-file-handle.js, test-fs-stat.js, and 10 more.