Довідник API node:fs

Elide надає node:fs, node:fs/promises, fs.promises і псевдонім elide:fs. Наведені нижче приклади охоплюють синхронні операції, операції на Promise, FileHandle і потоки.

Базове використання

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

Цей приклад перевіряє mkdtempSync, writeFileSync, readFileSync, statSync і rmSync. Помилки файлової системи можуть містити поля code, errno, syscall, path і dest.

Проміси та дескриптори файлів

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

Цей приклад перевіряє mkdtemp, writeFile, open і rm на основі Promise, а також FileHandle.read() і FileHandle.close(). Типові помилки Promise надають ті самі поля в стилі Node, що описані вище.

writeFile (і FileHandle.writeFile) також приймають синхронний або асинхронний ітерований об’єкт із рядків і буферів, зокрема потік Readable:

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

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

Потоки

createReadStream і createWriteStream повертають потоки Readable і Writable. Наведений нижче перевірений приклад копіює тимчасовий файл:

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

Стеження

Наявні watch, watchFile, unwatchFile і інтерфейс стеження на Promise. Відкритий спостерігач підтримує роботу скрипта, доки його не закрито:

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 недоступний.

Пісочниця

Доступ до файлової системи не обмежено, доки не передано прапорці пісочниці:

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

Коли пісочниця активна, заборонені операції завершуються помилкою замість доступу до шляху. Пріоритет прапорців і синтаксис списків шляхів описано в elide help sandbox.

Стандартні форми аргументів описано в документації Node.js щодо 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.