Class SyncKeyValueFileSystem

A "Synchronous key-value file system". Stores data to/retrieves data from an underlying 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.

Hierarchy

SynchronousFileSystem
- SyncKeyValueFileSystem
  - InMemory

Constructors

constructor

new SyncKeyValueFileSystem(options): SyncKeyValueFileSystem
Parameters
- options: SyncKeyValueFileSystemOptions
Returns SyncKeyValueFileSystem
Overrides SynchronousFileSystem.constructor
- Defined in src/backends/SyncStore.ts:219

Properties

`Protected` _ready

_ready: Promise<SyncKeyValueFileSystem> = ...

`Private` store

store: SyncKeyValueStore

`Static` `Readonly` Name

Name: string = ...

Accessors

metadata

get metadata(): FileSystemMetadata
Returns FileSystemMetadata
Inherited from SynchronousFileSystem.metadata
- Defined in src/filesystem.ts:672

Methods

`Private` _findINode

_findINode(tx, parent, filename, visited?): string
Helper function for findINode.
Parameters
- tx: SyncKeyValueROTransaction
- 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 string
string The ID of the file's inode in the file system.
- Defined in src/backends/SyncStore.ts:445

_syncSync

_syncSync(p, data, stats): void
Parameters
- p: string
- data: Uint8Array
- stats: Stats
Returns void
- Defined in src/backends/SyncStore.ts:397

access

access(p, mode, cred): Promise<void>
Asynchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.access
- Defined in src/filesystem.ts:676

accessSync

accessSync(p, mode, cred): void
Synchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Overrides SynchronousFileSystem.accessSync
- Defined in src/backends/SyncStore.ts:251

`Private` addNewNode

addNewNode(tx, data): string
Creates a new node under a random ID. Retries 5 times before giving up in the exceedingly unlikely chance that we try to reuse a random GUID.
Parameters
- tx: SyncKeyValueRWTransaction
- data: Uint8Array
Returns string
The GUID that the data was stored under.
- Defined in src/backends/SyncStore.ts:519

appendFile

appendFile(fname, data, flag, mode, cred): Promise<void>
Asynchronously append data to a file, creating the file if it not yet exists.
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.appendFile
- Defined in src/filesystem.ts:608

appendFileSync

appendFileSync(fname, data, flag, mode, cred): void
Synchronously append data to a file, creating the file if it not yet exists.
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.appendFileSync
- Defined in src/filesystem.ts:619

chmod

chmod(p, mode, cred): Promise<void>
Asynchronous chmod.
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.chmod
- Defined in src/filesystem.ts:708

chmodSync

chmodSync(p, mode, cred): void
Synchronous chmod.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Overrides SynchronousFileSystem.chmodSync
- Defined in src/backends/SyncStore.ts:387

chown

chown(p, new_uid, new_gid, cred): Promise<void>
Asynchronous chown.
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.chown
- Defined in src/filesystem.ts:712

chownSync

chownSync(p, new_uid, new_gid, cred): void
Synchronous chown.
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Overrides SynchronousFileSystem.chownSync
- Defined in src/backends/SyncStore.ts:392

`Private` commitNewFile

commitNewFile(tx, p, type, mode, cred, data): default
Commits a new file (well, a FILE or a DIRECTORY) to the file system with the given mode. Note: This will commit the transaction.
Parameters
- tx: SyncKeyValueRWTransaction
- p: 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.
- cred: Cred
- data: Uint8Array
  
  The data to store at the file's data node.
Returns default
The Inode for the new file.
- Defined in src/backends/SyncStore.ts:544

createFile

createFile(p, flag, mode, cred): Promise<File>
Create the file at path p with the given mode. Then, open it with the given flag.
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Inherited from SynchronousFileSystem.createFile
- Defined in src/filesystem.ts:338

createFileSync

createFileSync(p, flag, mode, cred): SyncKeyValueFile
Create the file at path p with the given mode. Then, open it with the given flag.
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns SyncKeyValueFile
Overrides SynchronousFileSystem.createFileSync
- Defined in src/backends/SyncStore.ts:338

empty

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

Returns void
- Defined in src/backends/SyncStore.ts:245

exists

exists(p, cred): Promise<boolean>
Test whether or not the given path exists by checking with the file system. Then call the callback argument with either true or false.
Parameters
- p: string
- cred: Cred
Returns Promise<boolean>
Inherited from SynchronousFileSystem.exists
- Defined in src/filesystem.ts:482

existsSync

existsSync(p, cred): boolean
Test whether or not the given path exists by checking with the file system.
Parameters
- p: string
- cred: Cred
Returns boolean
Inherited from SynchronousFileSystem.existsSync
- Defined in src/filesystem.ts:490

`Private` findINode

findINode(tx, p): default
Finds the Inode of the given path.
Parameters
- tx: SyncKeyValueROTransaction
- p: string
  
  The path to look up.
Returns default
The Inode of the path p.

Todo
memoize/cache
- Defined in src/backends/SyncStore.ts:481

`Private` getDirListing

getDirListing(tx, p, inode): {
[fileName: string]: string;
}
Given the Inode of a directory, retrieves the corresponding directory listing.
Parameters
- tx: SyncKeyValueROTransaction
- p: string
- inode: default
Returns {
[fileName: string]: string;
}
- [fileName: string]: string
- Defined in src/backends/SyncStore.ts:503

`Private` getINode

getINode(tx, p, id): default
Given the ID of a node, retrieves the corresponding Inode.
Parameters
- tx: SyncKeyValueROTransaction
  
  The transaction to use.
- p: string
  
  The corresponding path to the file (used for error messages).
- id: string
  
  The ID to look up.
Returns default
- Defined in src/backends/SyncStore.ts:491

getName

getName(): string
Returns string
- Defined in src/backends/SyncStore.ts:226

isReadOnly

isReadOnly(): boolean
Returns boolean
- Defined in src/backends/SyncStore.ts:229

link

link(srcpath, dstpath, cred): Promise<void>
Asynchronous link.
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.link
- Defined in src/filesystem.ts:720

linkSync

linkSync(srcpath, dstpath, cred): void
Synchronous link.
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.linkSync
- Defined in src/filesystem.ts:651

`Private` makeRootDirectory

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

Returns void
- Defined in src/backends/SyncStore.ts:423

mkdir

mkdir(p, mode, cred): Promise<void>
Asynchronous mkdir.
Parameters
- p: string
- mode: number
  
  Mode to make the directory using. Can be ignored if the filesystem doesn't support permissions.
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.mkdir
- Defined in src/filesystem.ts:700

mkdirSync

mkdirSync(p, mode, cred): void
Synchronous mkdir.
Parameters
- p: string
- mode: number
  
  Mode to make the directory using. Can be ignored if the filesystem doesn't support permissions.
- cred: Cred
Returns void
Overrides SynchronousFileSystem.mkdirSync
- Defined in src/backends/SyncStore.ts:372

open

open(p, flags, mode, cred): Promise<File>
Asynchronous file open.
Parameters
- p: string
- flags: FileFlag
- mode: number
  
  Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.
- cred: Cred
Returns Promise<File>

See
http://www.manpagez.com/man/2/open/
Inherited from SynchronousFileSystem.open
- Defined in src/filesystem.ts:688

openFile

openFile(p, flag, cred): Promise<File>
Opens the file at path p with the given flag. The file must exist.
Parameters
- p: string
  
  The path to open.
- flag: FileFlag
  
  The flag to use when opening the file.
- cred: Cred
Returns Promise<File>
Inherited from SynchronousFileSystem.openFile
- Defined in src/filesystem.ts:331

openFileSync

openFileSync(p, flag, cred): SyncKeyValueFile
Opens the file at path p with the given flag. The file must exist.
Parameters
- p: string
  
  The path to open.
- flag: FileFlag
  
  The flag to use when opening the file.
- cred: Cred
Returns SyncKeyValueFile
A File object corresponding to the opened file.
Overrides SynchronousFileSystem.openFileSync
- Defined in src/backends/SyncStore.ts:346

openSync

openSync(p, flag, mode, cred): File
Synchronous file open.
Parameters
- p: string
- flag: FileFlag
- mode: number
  
  Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.
- cred: Cred
Returns File

See
http://www.manpagez.com/man/2/open/
Inherited from SynchronousFileSystem.openSync
- Defined in src/filesystem.ts:415

readFile

readFile(fname, flag, cred): Promise<Uint8Array>
Asynchronously reads the entire contents of a file.
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Inherited from SynchronousFileSystem.readFile
- Defined in src/filesystem.ts:554

readFileSync

readFileSync(fname, flag, cred): Uint8Array
Synchronously reads the entire contents of a file.
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Uint8Array
Inherited from SynchronousFileSystem.readFileSync
- Defined in src/filesystem.ts:568

readdir

readdir(p, cred): Promise<string[]>
Asynchronous readdir. Reads the contents of a directory.

The callback gets two arguments (err, files) where files is an array of the names of the files in the directory excluding '.' and '..'.
Parameters
- p: string
- cred: Cred
Returns Promise<string[]>
Inherited from SynchronousFileSystem.readdir
- Defined in src/filesystem.ts:704

readdirSync

readdirSync(p, cred): string[]
Synchronous readdir. Reads the contents of a directory.
Parameters
- p: string
- cred: Cred
Returns string[]
Overrides SynchronousFileSystem.readdirSync
- Defined in src/backends/SyncStore.ts:378

readlink

readlink(p, cred): Promise<string>
Asynchronous readlink.
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from SynchronousFileSystem.readlink
- Defined in src/filesystem.ts:728

readlinkSync

readlinkSync(p, cred): string
Synchronous readlink.
Parameters
- p: string
- cred: Cred
Returns string
Inherited from SynchronousFileSystem.readlinkSync
- Defined in src/filesystem.ts:663

realpath

realpath(p, cred): Promise<string>
Asynchronous realpath. The callback gets two arguments (err, resolvedPath).

Note that the Node API will resolve path to an absolute path.
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from SynchronousFileSystem.realpath
- Defined in src/filesystem.ts:498

realpathSync

realpathSync(p, cred): string
Synchronous realpath.

Note that the Node API will resolve path to an absolute path.
Parameters
- p: string
- cred: Cred
Returns string
Inherited from SynchronousFileSystem.realpathSync
- Defined in src/filesystem.ts:517

`Private` removeEntry

removeEntry(p, isDir, cred): void
Remove all traces of the given path from the file system.
Parameters
- p: string
  
  The path to remove from the file system.
- isDir: boolean
  
  Does the path belong to a directory, or a file?
- cred: Cred
Returns void

Todo
Update mtime.
- Defined in src/backends/SyncStore.ts:592

rename

rename(oldPath, newPath, cred): Promise<void>
Asynchronous rename. No arguments other than a possible exception are given to the completion callback.
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.rename
- Defined in src/filesystem.ts:680

renameSync

renameSync(oldPath, newPath, cred): void
Synchronous rename.
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Overrides SynchronousFileSystem.renameSync
- Defined in src/backends/SyncStore.ts:259

rmdir

rmdir(p, cred): Promise<void>
Asynchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.rmdir
- Defined in src/filesystem.ts:696

rmdirSync

rmdirSync(p, cred): void
Synchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns void
Overrides SynchronousFileSystem.rmdirSync
- Defined in src/backends/SyncStore.ts:363

stat

stat(p, cred): Promise<Stats>
Asynchronous stat.
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Inherited from SynchronousFileSystem.stat
- Defined in src/filesystem.ts:684

statSync

statSync(p, cred): Stats
Synchronous stat.
Parameters
- p: string
- cred: Cred
Returns Stats
Overrides SynchronousFileSystem.statSync
- Defined in src/backends/SyncStore.ts:329

supportsProps

supportsProps(): boolean
Returns boolean
- Defined in src/backends/SyncStore.ts:235

supportsSymlinks

supportsSymlinks(): boolean
Returns boolean
- Defined in src/backends/SyncStore.ts:232

supportsSynch

supportsSynch(): boolean
Returns boolean
- Defined in src/backends/SyncStore.ts:238

symlink

symlink(srcpath, dstpath, type, cred): Promise<void>
Asynchronous symlink.
Parameters
- srcpath: string
- dstpath: string
- type: string
  
  can be either 'dir' or 'file'
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.symlink
- Defined in src/filesystem.ts:724

symlinkSync

symlinkSync(srcpath, dstpath, type, cred): void
Synchronous symlink.
Parameters
- srcpath: string
- dstpath: string
- type: string
  
  can be either 'dir' or 'file'
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.symlinkSync
- Defined in src/filesystem.ts:657

truncate

truncate(p, len, cred): Promise<void>
Asynchronous truncate.
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.truncate
- Defined in src/filesystem.ts:537

truncateSync

truncateSync(p, len, cred): void
Synchronous truncate.
Parameters
- p: string
- len: number
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.truncateSync
- Defined in src/filesystem.ts:545

unlink

unlink(p, cred): Promise<void>
Asynchronous unlink.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.unlink
- Defined in src/filesystem.ts:692

unlinkSync

unlinkSync(p, cred): void
Synchronous unlink.
Parameters
- p: string
- cred: Cred
Returns void
Overrides SynchronousFileSystem.unlinkSync
- Defined in src/backends/SyncStore.ts:359

utimes

utimes(p, atime, mtime, cred): Promise<void>
Change file timestamps of the file referenced by the supplied path.
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.utimes
- Defined in src/filesystem.ts:716

utimesSync

utimesSync(p, atime, mtime, cred): void
Change file timestamps of the file referenced by the supplied path.
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.utimesSync
- Defined in src/filesystem.ts:645

whenReady

whenReady(): Promise<SyncKeyValueFileSystem>
Returns Promise<SyncKeyValueFileSystem>
Inherited from SynchronousFileSystem.whenReady
- Defined in src/filesystem.ts:322

writeFile

writeFile(fname, data, flag, mode, cred): Promise<void>
Asynchronously writes data to a file, replacing the file if it already exists.

The encoding option is ignored if data is a buffer.
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from SynchronousFileSystem.writeFile
- Defined in src/filesystem.ts:582

writeFileSync

writeFileSync(fname, data, flag, mode, cred): void
Synchronously writes data to a file, replacing the file if it already exists.

The encoding option is ignored if data is a buffer.
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from SynchronousFileSystem.writeFileSync
- Defined in src/filesystem.ts:595

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in src/backends/SyncStore.ts:213

Class SyncKeyValueFileSystem

Todo

Todo

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: SyncKeyValueFileSystemOptions

Returns SyncKeyValueFileSystem

Properties

Protected _ready

Private store

Static Readonly Name

Accessors

metadata

Returns FileSystemMetadata

Methods

Private _findINode

Parameters

tx: SyncKeyValueROTransaction

parent: string

filename: string

visited: Set<string> = ...

Returns string

_syncSync

Parameters

p: string

data: Uint8Array

stats: Stats

Returns void

access

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

accessSync

Parameters

p: string

mode: number

cred: Cred

Returns void

Private addNewNode

Parameters

tx: SyncKeyValueRWTransaction

data: Uint8Array

Returns string

appendFile

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns Promise<void>

appendFileSync

Parameters

fname: string

data: Uint8Array

flag: FileFlag

mode: number

cred: Cred

Returns void

chmod

Parameters

p: string

mode: number

cred: Cred

Returns Promise<void>

chmodSync

Parameters

p: string

mode: number

cred: Cred

Returns void

`Protected` _ready

`Private` store

`Static` `Readonly` Name

`Private` _findINode

`Private` addNewNode

`Private` commitNewFile

`Private` findINode

`Private` getDirListing

Returns {
[fileName: string]: string;
}

`Private` getINode