Interface: LocalFileSystemOptions
Options for LocalFileSystem.
Properties
Section titled “Properties”contained?
Section titled “contained?”
optionalcontained?:boolean
Keep every resolved path under root. Defaults to true. When false, absolute input paths are accepted as-is (no sandbox).
createRoot?
Section titled “createRoot?”
optionalcreateRoot?:boolean
Create root (and parents) during init. Defaults to true.
optionalid?:string
Unique identifier. Defaults to a stable hash of the absolute root.
optionalos?:ResolveOsPathsOptions
Injectables forwarded to resolveLocalRoot for ~ expansion (home /
temp / cwd overrides). Mainly for tests: bun’s os.homedir() ignores a
process-set HOME, so overriding home via { os: { homeDir } } is the
runtime-agnostic way to point a ~ root at a chosen directory.
readOnly?
Section titled “readOnly?”
optionalreadOnly?:boolean
Block all write operations. Defaults to false.
root:
string
Root directory on disk. Relative paths resolve against process.cwd().
~ / ~/... expand via os.homedir() (before HOME), App /home/app,
or a created ./.home (create failures skip).
Stored on LocalFileSystem.root in POSIX form.