@anymux/file-system

Core file system interface and in-memory implementation for AnyMux.

Installation

pnpm add @anymux/file-system

Usage

import { MemoryFileSystem } from "@anymux/file-system/mem-fs";

const fs = new MemoryFileSystem();

await fs.writeFile("/hello.txt", "Hello, world!");
const content = await fs.readFile("/hello.txt", "utf-8");

API Overview

IFileSystem

The core interface matching Node.js fs.promises:

• readFile(path, options?) — Read file contents
• writeFile(path, data, options?) — Write data to a file
• mkdir(path, options?) — Create directories
• readdir(path, options?) — List directory contents
• stat(path) / lstat(path) — Get file metadata
• rename(oldPath, newPath) — Rename/move files
• unlink(path) — Delete files
• rmdir(path) / rm(path, options?) — Remove directories
• copyFile(src, dest) — Copy files
• symlink(target, path) — Create symbolic links
• createReadStream(path) / createWriteStream(path) — Streaming I/O
• watch(path, options?) — Watch for changes

MemoryFileSystem

A complete in-memory implementation of IFileSystem. Useful for testing, prototyping, and browser environments.

Additional Interfaces

• IProvider — Base provider with capability discovery
• IObjectStorage — S3-compatible object storage operations
• IGitRepo — Git repository operations (branches, commits, tags)
• IGitHost — Git hosting platform operations (PRs, issues, releases)

License

MIT