Class OPFSFileSystem

Implementation of IFileSystem using the Origin Private File System (OPFS) API. This provides persistent file storage that survives browser restarts and is private to the origin.

Implements

IFileSystem

Index

Methods

createDirectory deleteDirectory deleteFile directoryExists fileExists listDirectory readFile writeFile CreateAsync IsSupported

Methods

createDirectory

createDirectory(path: string): Promise<boolean>
Creates a directory at the specified path.
Parameters
- path: string
  The directory path to create
Returns Promise<boolean>
Boolean indicating success or failure
Implementation of IFileSystem.createDirectory
- Defined in src/ts/backend/save/opfsFileSystem.ts:110

deleteDirectory

deleteDirectory(path: string): Promise<boolean>
Deletes a directory at the specified path.
Parameters
- path: string
  The directory path to delete
Returns Promise<boolean>
Boolean indicating success or failure
Implementation of IFileSystem.deleteDirectory
- Defined in src/ts/backend/save/opfsFileSystem.ts:120

deleteFile

deleteFile(path: string): Promise<boolean>
Deletes a file.
Parameters
- path: string
  The file path to delete
Returns Promise<boolean>
Boolean indicating success or failure
Implementation of IFileSystem.deleteFile
- Defined in src/ts/backend/save/opfsFileSystem.ts:188

directoryExists

directoryExists(path: string): Promise<boolean>
Checks if a directory exists.
Parameters
- path: string
  The directory path to check
Returns Promise<boolean>
Boolean indicating if directory exists
Implementation of IFileSystem.directoryExists
- Defined in src/ts/backend/save/opfsFileSystem.ts:154

fileExists

fileExists(path: string): Promise<boolean>
Checks if a file exists.
Parameters
- path: string
  The file path to check
Returns Promise<boolean>
Boolean indicating if file exists
Implementation of IFileSystem.fileExists
- Defined in src/ts/backend/save/opfsFileSystem.ts:205

listDirectory

listDirectory(path: string): Promise<null | string[]>
Lists the contents of a directory.
Parameters
- path: string
  The directory path to list
Returns Promise<null | string[]>
Array of file/directory names, or null if directory doesn't exist
Implementation of IFileSystem.listDirectory
- Defined in src/ts/backend/save/opfsFileSystem.ts:137

readFile

readFile(path: string): Promise<null | string>
Reads content from a file.
Parameters
- path: string
  The file path to read from
Returns Promise<null | string>
File content or null if file doesn't exist
Implementation of IFileSystem.readFile
- Defined in src/ts/backend/save/opfsFileSystem.ts:175

writeFile

writeFile(path: string, content: string): Promise<boolean>
Writes content to a file.
Parameters
- path: string
  The file path to write to
- content: string
  The content to write
Returns Promise<boolean>
Boolean indicating success or failure
Implementation of IFileSystem.writeFile
- Defined in src/ts/backend/save/opfsFileSystem.ts:159

`Static`CreateAsync

CreateAsync(): Promise<Result<OPFSFileSystem, unknown>>
Factory method to create an OPFSFileSystem instance.

Returns Promise<Result<OPFSFileSystem, unknown>>
The created OPFSFileSystem instance
- Defined in src/ts/backend/save/opfsFileSystem.ts:48

`Static`IsSupported

IsSupported(): boolean
Checks if OPFS is supported in the current browser.

Returns boolean
Boolean indicating OPFS support
- Defined in src/ts/backend/save/opfsFileSystem.ts:214