Interface: MastraFileSystemAdapterOptions
Options for filesystems / MastraFileSystemAdapter.
Extends
Section titled “Extends”MastraFilesystemOptions
Properties
Section titled “Properties”description?
Section titled “description?”
optionaldescription?:string
Mount description surfaced by composite filesystem listings and help.
displayName?
Section titled “displayName?”
optionaldisplayName?:string
Human-friendly mount name surfaced by composite filesystem listings.
optionalid?:string
Override the Mastra filesystem id. Defaults to the source FileSystem.id.
instructions?
Section titled “instructions?”
optionalinstructions?:string
Replace the generated filesystem usage instructions.
optionalname?:string
Override the Mastra display name. Defaults to MastraFileSystemAdapter.
onDestroy?
Section titled “onDestroy?”
optionalonDestroy?:FilesystemLifecycleHook
Called before the filesystem is destroyed
Inherited from
Section titled “Inherited from”MastraFilesystemOptions.onDestroy
onInit?
Section titled “onInit?”
optionalonInit?:FilesystemLifecycleHook
Called after the filesystem reaches ‘ready’ status
Inherited from
Section titled “Inherited from”MastraFilesystemOptions.onInit
provider?
Section titled “provider?”
optionalprovider?:string
Override the Mastra provider id. Defaults to the source FileSystem.backend.
readOnly?
Section titled “readOnly?”
optionalreadOnly?:boolean
Force read-only mounts even when the source filesystem allows writes. The source FileSystem.readOnly flag still applies either way.
textExtensions?
Section titled “textExtensions?”
optionaltextExtensions?:string[]
Additional file extensions to treat as text, extending (not replacing) the
built-in set. Affects which files tools like grep will search.
Values are normalized to lowercase and dot-prefixed, so 'sas', '.sas',
and '.SAS' are equivalent.
Example
Section titled “Example”new LocalFilesystem({ basePath: '.', textExtensions: ['.sas', '.log'] })Inherited from
Section titled “Inherited from”MastraFilesystemOptions.textExtensions