Referencia de la API node:fs

Elide expone node:fs, node:fs/promises, fs.promises y el alias elide:fs. Los ejemplos siguientes cubren operaciones síncronas, con Promise, con FileHandle y con flujos.

Uso básico

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

Este ejemplo verifica mkdtempSync, writeFileSync, readFileSync, statSync y rmSync. Los fallos del sistema de archivos pueden llevar los campos code, errno, syscall, path y dest.

Promesas y manejadores de archivo

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

Este ejemplo verifica mkdtemp, writeFile, open y rm basados en Promise, además de FileHandle.read() y FileHandle.close(). Los fallos representativos con Promise exponen los mismos campos al estilo de Node descritos antes.

writeFile (y FileHandle.writeFile) también aceptan un iterable síncrono o asíncrono de cadenas y buffers, incluido un flujo Readable:

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

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

Flujos

createReadStream y createWriteStream devuelven flujos Readable y Writable. El siguiente ejemplo verificado copia un archivo temporal:

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

Observación

watch, watchFile, unwatchFile y la superficie de observación con Promise están presentes. Un observador abierto mantiene vivo el script hasta que se cierra:

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 no está disponible.

Sandbox

El acceso al sistema de archivos no está restringido hasta que se indican opciones de sandbox:

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

Con un sandbox activo, las operaciones denegadas fallan en lugar de acceder a la ruta. Consulte elide help sandbox para conocer la precedencia de las opciones y la sintaxis de las listas de rutas.

Consulte la documentación de fs de Node.js para ver las formas estándar de los argumentos.

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.