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

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:34

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, parent, filename, visited?): bigint
Helper function for findINode.
Parameters
- tx: Transaction<Store>
- parent: string
  The parent directory of the file we are attempting to find.
- filename: string
  The filename of the inode we are attempting to find, minus the parent.
- visited: Set<string> = ...
Returns bigint
string The ID of the file's inode in the file system.
- Defined in src/backends/store/fs.ts:395

`Protected`addNewSync

addNewSync(tx, data, path): bigint
Creates a new node under a random ID. Retries before giving up in the exceedingly unlikely chance that we try to reuse a random ino.
Parameters
- tx: Transaction<Store>
- data: Uint8Array
- path: string
Returns bigint
The ino that the data was stored under.
- Defined in src/backends/store/fs.ts:516

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:329

checkRootSync

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

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

`Protected`commitNewSync

commitNewSync(path, type, mode, data?): Inode
Commits a new file (well, a FILE or a DIRECTORY) to the file system with mode. Note: This will commit the transaction.
Parameters
- path: string
  The path to the new file.
- type: FileType
  The type of the new file.
- mode: number
  The mode to create the new file with.
- data: Uint8Array = ...
  The data to store at the file's data node.
Returns Inode
The Inode for the new file.
- Defined in src/backends/store/fs.ts:583

createFile

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

createFileSync

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

empty

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

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

emptySync

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

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

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, visited?): Inode
Finds the Inode of path.
Parameters
- tx: Transaction<Store>
- path: string
  The path to look up.
- visited: Set<string> = ...
Returns Inode
The Inode of the path p.

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

`Protected`getDirListingSync

getDirListingSync(tx, inode, p?): {
[fileName: string]: Ino;
}
Given the Inode of a directory, retrieves the corresponding directory listing.
Parameters
- tx: Transaction<Store>
- inode: Inode
- Optionalp: string
Returns {
[fileName: string]: Ino;
}
- [fileName: string]: Ino
- Defined in src/backends/store/fs.ts:487

`Protected`getINodeSync

getINodeSync(tx, id, path): Inode
Given the ID of a node, retrieves the corresponding Inode.
Parameters
- tx: Transaction<Store>
  The transaction to use.
- id: bigint
  The ID to look up.
- path: string
  The corresponding path to the file (used for error messages).
Returns Inode
- Defined in src/backends/store/fs.ts:458

link

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

linkSync

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

metadata

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

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

mkdir

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

mkdirSync

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

openFile

openFile(path, flag): Promise<File>
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>
Overrides FileSystem.openFile
- Defined in src/backends/store/fs.ts:186

openFileSync

openFileSync(path, flag): File
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
Overrides FileSystem.openFileSync
- Defined in src/backends/store/fs.ts:196

readdir

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

readdirSync

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

ready

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

`Protected`removeSync

removeSync(path, isDir): void
Remove all traces of path from the file system.
Parameters
- path: string
  The path to remove from the file system.
- isDir: boolean
  Does the path belong to a directory, or a file?
Returns void
Todo
Update mtime.
- Defined in src/backends/store/fs.ts:666

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:68

renameSync

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

rmdir

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

rmdirSync

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

stat

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

statSync

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

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:252

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:273

unlink

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

unlinkSync

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

Class StoreFS<T>Internal

Todo

Todo

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns StoreFS<T>

Properties

Protected Optional Internal_disableSync

Protectedstore

Methods

Protected_findINodeSync

Parameters

Returns bigint

ProtectedaddNewSync

Parameters

Returns bigint

checkRoot

Returns Promise<void>

checkRootSync

Returns void

ProtectedcommitNewSync

Parameters

Returns Inode

createFile

Parameters

Returns Promise<File>

createFileSync

Parameters

Returns File

empty

Returns Promise<void>

Deprecated

emptySync

Returns void

Deprecated

exists

Parameters

Returns Promise<boolean>

existsSync

Parameters

Returns boolean

ProtectedfindINodeSync

Parameters

Returns Inode

Todo

ProtectedgetDirListingSync

Parameters

Returns { [fileName: string]: Ino; }

[fileName: string]: Ino

ProtectedgetINodeSync

Parameters

Returns Inode

link

Parameters

Returns Promise<void>

linkSync

Parameters

Returns void

metadata

Returns FileSystemMetadata

mkdir

Parameters

Returns Promise<void>

mkdirSync

Parameters

Returns void

openFile

Parameters

Returns Promise<File>

openFileSync

Parameters

Returns File

Class StoreFS<T>`Internal`

`Protected` `Optional` `Internal`_disableSync

`Protected`store

`Protected`_findINodeSync

`Protected`addNewSync

`Protected`commitNewSync

`Protected`findINodeSync

`Protected`getDirListingSync

Returns {
[fileName: string]: Ino;
}

`Protected`getINodeSync

`Protected`removeSync