Class: MastraFileSystemAdapter

Thin Mastra MastraFilesystem adapter over a @dbx-tools/shared-fs FileSystem. Identity fields are getters that read the source on access; construction does not snapshot them.

Extends

• MastraFilesystem

Constructors

Constructor

new MastraFileSystemAdapter(fs, options?): MastraFileSystemAdapter

Parameters

fs

FileSystem

options?

MastraFileSystemAdapterOptions = {}

Returns

MastraFileSystemAdapter

Overrides

MastraFilesystem.constructor

Properties

component

component: RegisteredLogger

Inherited from

MastraFilesystem.component

---

error?

optional error?: string

Error message when status is ‘error’

Inherited from

MastraFilesystem.error

---

logger

protected logger: IMastraLogger

Inherited from

MastraFilesystem.logger

---

status

status: ProviderStatus = "pending"

Current status of the filesystem

Overrides

MastraFilesystem.status

Accessors

basePath

Get Signature

get basePath(): string

Returns

string

---

id

Get Signature

get id(): string

Unique identifier for this filesystem instance

Returns

string

Overrides

MastraFilesystem.id

---

name

Get Signature

get name(): string

Human-readable name (e.g., ‘LocalFilesystem’, ‘AgentFS’)

Returns

string

Overrides

MastraFilesystem.name

---

provider

Get Signature

get provider(): string

Provider type identifier

Returns

string

Overrides

MastraFilesystem.provider

---

readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Methods

__setLogger()

__setLogger(logger): void

Set the logger for the agent

Parameters

logger

IMastraLogger

Returns

void

Inherited from

MastraFilesystem.__setLogger

---

__setRawConfig()

__setRawConfig(rawConfig): void

Internal

Sets the raw storage configuration for this primitive.

Parameters

rawConfig

Record<string, unknown>

Returns

void

Inherited from

MastraFilesystem.__setRawConfig

---

_destroy()

_destroy(): Promise<void>

Destroy the filesystem and clean up all resources (wrapper with status management).

This method is race-condition-safe - concurrent calls will return the same promise. Handles status management.

Subclasses override destroy() to provide their destroy logic.

Returns

Promise<void>

Inherited from

MastraFilesystem._destroy

---

_init()

_init(): Promise<void>

Initialize the filesystem (wrapper with status management and race-condition safety).

This method is race-condition-safe - concurrent calls will return the same promise. Handles status management automatically.

Subclasses override init() to provide their initialization logic.

Returns

Promise<void>

Inherited from

MastraFilesystem._init

---

appendFile()

appendFile(inputPath, content): Promise<void>

Parameters

inputPath

string

content

FileContent

Returns

Promise<void>

Overrides

MastraFilesystem.appendFile

---

copyFile()

copyFile(src, dest, options?): Promise<void>

Parameters

src

string

dest

string

options?

CopyOptions

Returns

Promise<void>

Overrides

MastraFilesystem.copyFile

---

deleteFile()

deleteFile(inputPath, options?): Promise<void>

Parameters

inputPath

string

options?

RemoveOptions

Returns

Promise<void>

Overrides

MastraFilesystem.deleteFile

---

destroy()

destroy(): Promise<void>

Override this method to implement filesystem destroy logic.

Called by _destroy() after status is set to ‘destroying’. Status will be set to ‘destroyed’ on success, ‘error’ on failure.

Returns

Promise<void>

Overrides

MastraFilesystem.destroy

---

ensureReady()

protected ensureReady(): Promise<void>

Ensure the filesystem is ready.

Calls _init() if status is not ‘ready’. Useful for lazy initialization where operations should automatically initialize the filesystem if needed.

Returns

Promise<void>

Throws

if the filesystem fails to reach ‘ready’ status

Example

async readFile(path: string): Promise<string | Buffer> {
  await this.ensureReady();
  // Now safe to use the filesystem
}

Inherited from

MastraFilesystem.ensureReady

---

exists()

exists(inputPath): Promise<boolean>

Parameters

inputPath

string

Returns

Promise<boolean>

Overrides

MastraFilesystem.exists

---

getInfo()

getInfo(): FilesystemInfo<{ backend: string; root: string; }>

Returns

FilesystemInfo<{ backend: string; root: string; }>

---

getInstructions()

getInstructions(): string

Returns

string

---

init()

init(): Promise<void>

Override this method to implement filesystem initialization logic.

Called by _init() after status is set to ‘initializing’. Status will be set to ‘ready’ on success, ‘error’ on failure.

Returns

Promise<void>

Example

async init(): Promise<void> {
  this._client = new StorageClient({ ... });
  await this._client.connect();
}

Overrides

MastraFilesystem.init

---

mkdir()

mkdir(inputPath, options?): Promise<void>

Parameters

inputPath

string

options?

recursive?

boolean

Returns

Promise<void>

Overrides

MastraFilesystem.mkdir

---

moveFile()

moveFile(src, dest, options?): Promise<void>

Parameters

src

string

dest

string

options?

CopyOptions

Returns

Promise<void>

Overrides

MastraFilesystem.moveFile

---

readdir()

readdir(inputPath, options?): Promise<FileEntry[]>

Parameters

inputPath

string

options?

ListOptions

Returns

Promise<FileEntry[]>

Overrides

MastraFilesystem.readdir

---

readFile()

readFile(inputPath, options?): Promise<string | Buffer<ArrayBufferLike>>

Parameters

inputPath

string

options?

ReadOptions

Returns

Promise<string | Buffer<ArrayBufferLike>>

Overrides

MastraFilesystem.readFile

---

rmdir()

rmdir(inputPath, options?): Promise<void>

Parameters

inputPath

string

options?

RemoveOptions

Returns

Promise<void>

Overrides

MastraFilesystem.rmdir

---

stat()

stat(inputPath): Promise<FileStat>

Parameters

inputPath

string

Returns

Promise<FileStat>

Overrides

MastraFilesystem.stat

---

toRawConfig()

toRawConfig(): Record<string, unknown> | undefined

Returns the raw storage configuration this primitive was created from, or undefined if it was created from code.

Returns

Record<string, unknown> | undefined

Inherited from

MastraFilesystem.toRawConfig

---

writeFile()

writeFile(inputPath, content, options?): Promise<void>

Parameters

inputPath

string

content

FileContent

options?

WriteOptions

Returns

Promise<void>

Overrides

MastraFilesystem.writeFile