---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/media/engines/fs_workspace/interfaces/FsLike.md
description: 'The slice of `node:fs/promises` the workspace uses.'
---

# Interface: FsLike

Defined in: [src/batteries/media/engines/fs\_workspace.ts:23](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L23)

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

## Methods

### mkdir()

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

Defined in: [src/batteries/media/engines/fs\_workspace.ts:25](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L25)

Create a directory (recursively).

#### Parameters

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

#### Returns

`Promise`<`unknown`>

***

### readdir()

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

Defined in: [src/batteries/media/engines/fs\_workspace.ts:31](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L31)

List directory entries (basenames).

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `path`    | `string` |

#### Returns

`Promise`<`string`\[]>

***

### readFile()

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

Defined in: [src/batteries/media/engines/fs\_workspace.ts:29](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L29)

Read a file's bytes.

#### Parameters

| Parameter | Type     |
| --------- | -------- |
| `path`    | `string` |

#### Returns

`Promise`<`Uint8Array`<`ArrayBufferLike`>>

***

### rm()

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

Defined in: [src/batteries/media/engines/fs\_workspace.ts:33](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L33)

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()

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

Defined in: [src/batteries/media/engines/fs\_workspace.ts:27](https://github.com/NHTIO/ADK/blob/v1.20260713.1/src/src/batteries/media/engines/fs_workspace.ts#L27)

Write bytes to a path.

#### Parameters

| Parameter | Type         |
| --------- | ------------ |
| `path`    | `string`     |
| `data`    | `Uint8Array` |

#### Returns

`Promise`<`void`>