Class StoreFS<T>`Internal`

A file system which uses a key-value store.

We use a unique ID for each node in the file system. The root node has a fixed ID.

Todo

Introduce Node ID caching.

Todo

Check modes.

Type Parameters

T extends Store = Store

Hierarchy (view full)

FileSystem
- StoreFS
  - DeviceFS

Index

Constructors

constructor

new StoreFS<T>(store): StoreFS<T>
Type Parameters
- T extends Store = Store
Parameters
- store: T
Returns StoreFS<T>
Overrides FileSystem.constructor
- Defined in src/backends/store/fs.ts:35

Properties

`Protected` `Optional` `Internal`_disableSync

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

`Protected`store

store: T

Methods

`Protected`_findInodeSync

_findInodeSync(tx, path, syscall, visited?): bigint
Helper function for findINode.
Parameters
- tx: Transaction<Store>
- path: string
- syscall: string
- visited: Set<string> = ...
Returns bigint
string The ID of the file's inode in the file system.
- Defined in src/backends/store/fs.ts:390

checkRoot

checkRoot(): Promise<void>
Checks if the root directory exists. Creates it if it doesn't.

Returns Promise<void>
- Defined in src/backends/store/fs.ts:322

checkRootSync

checkRootSync(): void
Checks if the root directory exists. Creates it if it doesn't.

Returns void
- Defined in src/backends/store/fs.ts:340

createFile

createFile(path, flag, mode): Promise<File<FileSystem>>
Create the file at path with mode. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
Returns Promise<File<FileSystem>>
Overrides FileSystem.createFile
- Defined in src/backends/store/fs.ts:173

createFileSync

createFileSync(path, flag, mode): File<FileSystem>
Create the file at path with mode. Then, open it with flag.
Parameters
- path: string
- flag: string
- mode: number
Returns File<FileSystem>
Overrides FileSystem.createFileSync
- Defined in src/backends/store/fs.ts:178

empty

empty(): Promise<void>
Delete all contents stored in the file system.

Returns Promise<void>
Deprecated
- Defined in src/backends/store/fs.ts:50

emptySync

emptySync(): void
Delete all contents stored in the file system.

Returns void
Deprecated
- Defined in src/backends/store/fs.ts:60

exists

exists(path): Promise<boolean>
Test whether or not path exists.
Parameters
- path: string
Returns Promise<boolean>
Inherited from FileSystem.exists
- Defined in src/filesystem.ts:148

existsSync

existsSync(path): boolean
Test whether or not path exists.
Parameters
- path: string
Returns boolean
Inherited from FileSystem.existsSync
- Defined in src/filesystem.ts:160

`Protected`findInodeSync

findInodeSync(tx, path, syscall, visited?): Inode
Finds the Inode of path.
Parameters
- tx: Transaction<Store>
- path: string
  The path to look up.
- syscall: string
- visited: Set<string> = ...
Returns Inode
The Inode of the path p.

Todo
memoize/cache
- Defined in src/backends/store/fs.ts:428

link

link(target, link): Promise<void>
Parameters
- target: string
- link: string
Returns Promise<void>
Overrides FileSystem.link
- Defined in src/backends/store/fs.ts:283

linkSync

linkSync(target, link): void
Parameters
- target: string
- link: string
Returns void
Overrides FileSystem.linkSync
- Defined in src/backends/store/fs.ts:301

metadata

metadata(): FileSystemMetadata
Get metadata about the current file system

Returns FileSystemMetadata
Overrides FileSystem.metadata
- Defined in src/backends/store/fs.ts:39

mkdir

mkdir(path, mode): Promise<void>
Parameters
- path: string
- mode: number
Returns Promise<void>
Overrides FileSystem.mkdir
- Defined in src/backends/store/fs.ts:221

mkdirSync

mkdirSync(path, mode): void
Parameters
- path: string
- mode: number
Returns void
Overrides FileSystem.mkdirSync
- Defined in src/backends/store/fs.ts:225

openFile

openFile(path, flag): Promise<File<FileSystem>>
Opens the file at path with flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns Promise<File<FileSystem>>
Overrides FileSystem.openFile
- Defined in src/backends/store/fs.ts:183

openFileSync

openFileSync(path, flag): File<FileSystem>
Opens the file at path with flag. The file must exist.
Parameters
- path: string
  The path to open.
- flag: string
  The flag to use when opening the file.
Returns File<FileSystem>
Overrides FileSystem.openFileSync
- Defined in src/backends/store/fs.ts:191

readdir

readdir(path): Promise<string[]>
Parameters
- path: string
Returns Promise<string[]>
Overrides FileSystem.readdir
- Defined in src/backends/store/fs.ts:229

readdirSync

readdirSync(path): string[]
Parameters
- path: string
Returns string[]
Overrides FileSystem.readdirSync
- Defined in src/backends/store/fs.ts:235

ready

ready(): Promise<void>
Returns Promise<void>
Overrides FileSystem.ready
- Defined in src/backends/store/fs.ts:27

rename

rename(oldPath, newPath): Promise<void>
Parameters
- oldPath: string
- newPath: string
Returns Promise<void>
Todo
Make rename compatible with the cache.
Overrides FileSystem.rename
- Defined in src/backends/store/fs.ts:69

renameSync

renameSync(oldPath, newPath): void
Parameters
- oldPath: string
- newPath: string
Returns void
Overrides FileSystem.renameSync
- Defined in src/backends/store/fs.ts:116

rmdir

rmdir(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.rmdir
- Defined in src/backends/store/fs.ts:207

rmdirSync

rmdirSync(path): void
Parameters
- path: string
Returns void
Overrides FileSystem.rmdirSync
- Defined in src/backends/store/fs.ts:214

stat

stat(path): Promise<Stats>
Parameters
- path: string
Returns Promise<Stats>
Overrides FileSystem.stat
- Defined in src/backends/store/fs.ts:163

statSync

statSync(path): Stats
Parameters
- path: string
Returns Stats
Overrides FileSystem.statSync
- Defined in src/backends/store/fs.ts:168

sync

sync(path, data, stats): Promise<void>
Updated the inode and data node at path
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns Promise<void>
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Overrides FileSystem.sync
- Defined in src/backends/store/fs.ts:245

syncSync

syncSync(path, data, stats): void
Updated the inode and data node at path
Parameters
- path: string
- data: Uint8Array
- stats: Readonly<Stats>
Returns void
Todo
Ensure mtime updates properly, and use that to determine if a data update is required.
Overrides FileSystem.syncSync
- Defined in src/backends/store/fs.ts:266

unlink

unlink(path): Promise<void>
Parameters
- path: string
Returns Promise<void>
Overrides FileSystem.unlink
- Defined in src/backends/store/fs.ts:199

unlinkSync

unlinkSync(path): void
Parameters
- path: string
Returns void
Overrides FileSystem.unlinkSync
- Defined in src/backends/store/fs.ts:203