Interface: SandboxFileSystem

Defined in: src/batteries/sandbox/contracts/file_system.ts:6

Filesystem capability with no copy primitive; traversal is complete and terminal-framed.

Methods

delete()?

optional delete(path: string, o?: {
  signal?: AbortSignal;
}): Promise<void>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:27

Delete a path. Deletion is idempotent: deleting an absent path resolves.

Parameters

Parameter	Type
path	string
o?	{ signal?: AbortSignal; }
o.signal?	AbortSignal

Returns

Promise<void>

---

list()

list(path: string, o: {
  maxDepth: number;
  signal?: AbortSignal;
}): AsyncIterable<ListFrame>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:17

Lazily yield every item, followed by exactly one mandatory done frame.

Parameters

Parameter	Type
path	string
o	{ maxDepth: number; signal?: AbortSignal; }
o.maxDepth	number
o.signal?	AbortSignal

Returns

AsyncIterable<ListFrame>

---

mkdir()?

optional mkdir(path: string, o?: {
  signal?: AbortSignal;
}): Promise<void>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:34

Create a directory.

Parameters

Parameter	Type
path	string
o?	{ signal?: AbortSignal; }
o.signal?	AbortSignal

Returns

Promise<void>

---

read()

read(path: string, o?: {
  signal?: AbortSignal;
}): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:19

Open a fresh, replayable byte stream; non-regular kinds are refused by adapters.

Parameters

Parameter	Type
path	string
o?	{ signal?: AbortSignal; }
o.signal?	AbortSignal

Returns

Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

---

rename()?

optional rename(
   from: string,
   to: string,
   o?: {
  signal?: AbortSignal;
}): Promise<void>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:32

Move a path. MUST overwrite an existing destination (POSIX move semantics). Dev-tools relies on this behaviour when breaking rename cycles.

Parameters

Parameter	Type
from	string
to	string
o?	{ signal?: AbortSignal; }
o.signal?	AbortSignal

Returns

Promise<void>

---

stat()

stat(path: string): Promise<{
  dev?: number;
  ino?: number;
  kind: "other" | "file" | "dir" | "symlink";
  mtimeMs?: number;
  size: number;
  version: string;
}>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:8

Return metadata. A changed version token is evidence of change; equality is not a no-change guarantee.

Parameters

Parameter	Type
path	string

Returns

Promise<{ dev?: number; ino?: number; kind: "other" | "file" | "dir" | "symlink"; mtimeMs?: number; size: number; version: string; }>

---

write()

write(
   path: string,
   bytes:
  | Uint8Array<ArrayBufferLike>
  | ReadableStream<Uint8Array<ArrayBufferLike>>,
   o?: {
  signal?: AbortSignal;
}): Promise<void>;

Defined in: src/batteries/sandbox/contracts/file_system.ts:21

Write bytes without imposing a battery-level size cap.

Parameters

Parameter	Type
path	string
bytes	| Uint8Array<ArrayBufferLike> | ReadableStream<Uint8Array<ArrayBufferLike>>
o?	{ signal?: AbortSignal; }
o.signal?	AbortSignal

Returns

Promise<void>