Interface: FsLike

Defined in: src/batteries/media/engines/fs_workspace.ts:23

The slice of node:fs/promises the workspace uses.

Methods

mkdir()

mkdir(path: string, options: {
  recursive: true;
}): Promise<unknown>;

Defined in: src/batteries/media/engines/fs_workspace.ts:25

Create a directory (recursively).

Parameters

Parameter	Type
path	string
options	{ recursive: true; }
options.recursive	true

Returns

Promise<unknown>

---

readdir()

readdir(path: string): Promise<string[]>;

Defined in: src/batteries/media/engines/fs_workspace.ts:31

List directory entries (basenames).

Parameters

Parameter	Type
path	string

Returns

Promise<string[]>

---

readFile()

readFile(path: string): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: src/batteries/media/engines/fs_workspace.ts:29

Read a file's bytes.

Parameters

Parameter	Type
path	string

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

rm()

rm(path: string, options: {
  force: true;
  recursive: true;
}): Promise<void>;

Defined in: src/batteries/media/engines/fs_workspace.ts:33

Remove a path recursively, ignoring absence.

Parameters

Parameter	Type
path	string
options	{ force: true; recursive: true; }
options.force	true
options.recursive	true

Returns

Promise<void>

---

writeFile()

writeFile(path: string, data: Uint8Array): Promise<void>;

Defined in: src/batteries/media/engines/fs_workspace.ts:27

Write bytes to a path.

Parameters

Parameter	Type
path	string
data	Uint8Array

Returns

Promise<void>