@ricsam/quickjs-fs

File System Access API (OPFS-compatible) for QuickJS runtime.

> Note: This is a low-level package. For most use cases, use @ricsam/quickjs-runtime with createRuntime() instead.

Installation

``bash
bun add @ricsam/quickjs-fs
`

Setup

`typescript
import { setupFs, createNodeDirectoryHandle } from "@ricsam/quickjs-fs";

const handle = setupFs(context, {
getDirectory: async (path) => {
// Validate path access
if (!path.startsWith("/allowed")) {
throw new Error("Access denied");
}
return createNodeDirectoryHandle(./sandbox${path});
},
});
`

Injected Globals

- getDirectory(path) - Entry point for file system access
- FileSystemDirectoryHandle, FileSystemFileHandle
- FileSystemWritableFileStream

Usage in QuickJS

`javascript
// Get directory handle
const root = await getDirectory("/data");

// Read a file
const fileHandle = await root.getFileHandle("config.json");
const file = await fileHandle.getFile();
const text = await file.text();
const config = JSON.parse(text);

// Write a file
const outputHandle = await root.getFileHandle("output.txt", { create: true });
const writable = await outputHandle.createWritable();
await writable.write("Hello, World!");
await writable.close();

// Directory operations
const subDir = await root.getDirectoryHandle("subdir", { create: true });
await root.removeEntry("old-file.txt");
await root.removeEntry("old-dir", { recursive: true });

// Iterate directory
for await (const [name, handle] of root.entries()) {
console.log(name, handle.kind); // "file" or "directory"
}
`

Host Adapters

$3

`typescript
import { createNodeDirectoryHandle } from "@ricsam/quickjs-fs";

const dirHandle = createNodeDirectoryHandle("/path/to/directory");
`

$3

`typescript
import { createMemoryDirectoryHandle } from "@ricsam/quickjs-fs";

const memFs = createMemoryDirectoryHandle({
"config.json": JSON.stringify({ debug: true }),
"data/users.json": JSON.stringify([]),
});
``