Skip to content
dbx tools

Interface: BaseFileSystemOptions\<TBackend\>

Type Parameters

Section titled “Type Parameters”

TBackend

Section titled “TBackend”

TBackend extends string = string

Properties

Section titled “Properties”

backend

Section titled “backend”

backend: TBackend

createRoot?

Section titled “createRoot?”

optional createRoot?: boolean

Ensure root exists during init by calling createRootDirectory. Defaults to false (remote roots usually already exist). Local disk adapters typically pass true and override createRootDirectory.

id

Section titled “id”

id: string

readOnly?

Section titled “readOnly?”

optional readOnly?: boolean

root?

Section titled “root?”

optional root?: FileSystemRootInput

Filesystem root. One segment or a list of segments (FileSystemRootInput): primitives stringify, objects/arrays are FNV-hashed, then joined with / and normalized via posixPath.normalizeRoot. Defaults to /.