Class AsyncKeyValueFileSystem

An "Asynchronous key-value file system". Stores data to/retrieves data from an underlying asynchronous key-value store.

Hierarchy

BaseFileSystem
- AsyncKeyValueFileSystem

Constructors

constructor

new AsyncKeyValueFileSystem(cacheSize): AsyncKeyValueFileSystem
Parameters
- cacheSize: number
Returns AsyncKeyValueFileSystem
Overrides BaseFileSystem.constructor
- Defined in src/backends/AsyncStore.ts:195

Properties

`Private` _cache

_cache: LRUCache = null

`Protected` _ready

_ready: Promise<AsyncKeyValueFileSystem> = ...

`Protected` store

store: AsyncKeyValueStore

`Static` `Readonly` Name

Name: string = ...

Accessors

metadata

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

Methods

`Private` _findINode

_findINode(tx, parent, filename, visited?): Promise<string>
Helper function for findINode.
Parameters
- tx: AsyncKeyValueROTransaction
- 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 Promise<string>
- Defined in src/backends/AsyncStore.ts:451

_sync

_sync(p, data, stats): Promise<void>
Parameters
- p: string
- data: Uint8Array
- stats: Stats
Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:404

access

access(p, mode, cred): Promise<void>
Asynchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.access
- Defined in src/backends/AsyncStore.ts:239

accessSync

accessSync(p, mode, cred): void
Synchronous access.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.accessSync
- Defined in src/filesystem.ts:384

`Private` addNewNode

addNewNode(tx, data): Promise<string>
Adds 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: AsyncKeyValueRWTransaction
- data: Uint8Array
Returns Promise<string>
- Defined in src/backends/AsyncStore.ts:550

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 BaseFileSystem.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 BaseFileSystem.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>
Overrides BaseFileSystem.chmod
- Defined in src/backends/AsyncStore.ts:394

chmodSync

chmodSync(p, mode, cred): void
Synchronous chmod.
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chmodSync
- Defined in src/filesystem.ts:633

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>
Overrides BaseFileSystem.chown
- Defined in src/backends/AsyncStore.ts:399

chownSync

chownSync(p, new_uid, new_gid, cred): void
Synchronous chown.
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Inherited from BaseFileSystem.chownSync
- Defined in src/filesystem.ts:639

`Private` commitNewFile

commitNewFile(tx, p, type, mode, cred, data): Promise<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: AsyncKeyValueRWTransaction
- 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
  
  The UID/GID to create the file with
- data: Uint8Array
  
  The data to store at the file's data node.
Returns Promise<default>
- Defined in src/backends/AsyncStore.ts:580

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>
Overrides BaseFileSystem.createFile
- Defined in src/backends/AsyncStore.ts:345

createFileSync

createFileSync(p, flag, mode, cred): 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 File
Inherited from BaseFileSystem.createFileSync
- Defined in src/filesystem.ts:412

empty

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

Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:230

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 BaseFileSystem.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 BaseFileSystem.existsSync
- Defined in src/filesystem.ts:490

`Private` findINode

findINode(tx, p, visited?): Promise<default>
Finds the Inode of the given path.
Parameters
- tx: AsyncKeyValueROTransaction
- p: string
  
  The path to look up.
- visited: Set<string> = ...
Returns Promise<default>

Todo
memoize/cache
- Defined in src/backends/AsyncStore.ts:508

`Private` getDirListing

getDirListing(tx, p, inode): Promise<{
[fileName: string]: string;
}>
Given the Inode of a directory, retrieves the corresponding directory listing.
Parameters
- tx: AsyncKeyValueROTransaction
- p: string
- inode: default
Returns Promise<{
[fileName: string]: string;
}>
- Defined in src/backends/AsyncStore.ts:531

`Private` getINode

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

getName

getName(): string
Returns string
- Defined in src/backends/AsyncStore.ts:211

init

init(store): Promise<void>
Initializes the file system. Typically called by subclasses' async constructors.
Parameters
- store: AsyncKeyValueStore
Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:206

isReadOnly

isReadOnly(): boolean
Returns boolean
- Defined in src/backends/AsyncStore.ts:214

link

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

linkSync

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

`Private` makeRootDirectory

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

Returns Promise<void>
- Defined in src/backends/AsyncStore.ts:430

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>
Overrides BaseFileSystem.mkdir
- Defined in src/backends/AsyncStore.ts:379

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
Inherited from BaseFileSystem.mkdirSync
- Defined in src/filesystem.ts:473

open

open(p, flag, mode, cred): Promise<File>
Asynchronous 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 Promise<File>

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

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>
Overrides BaseFileSystem.openFile
- Defined in src/backends/AsyncStore.ts:353

openFileSync

openFileSync(p, flag, cred): 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 File
A File object corresponding to the opened file.
Inherited from BaseFileSystem.openFileSync
- Defined in src/filesystem.ts:405

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 BaseFileSystem.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 BaseFileSystem.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 BaseFileSystem.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[]>
Overrides BaseFileSystem.readdir
- Defined in src/backends/AsyncStore.ts:385

readdirSync

readdirSync(p, cred): string[]
Synchronous readdir. Reads the contents of a directory.
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from BaseFileSystem.readdirSync
- Defined in src/filesystem.ts:479

readlink

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

readlinkSync

readlinkSync(p, cred): string
Synchronous readlink.
Parameters
- p: string
- cred: Cred
Returns string
Inherited from BaseFileSystem.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 BaseFileSystem.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 BaseFileSystem.realpathSync
- Defined in src/filesystem.ts:517

`Private` removeEntry

removeEntry(p, isDir, cred): Promise<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 Promise<void>

Todo
Update mtime.
- Defined in src/backends/AsyncStore.ts:633

rename

rename(oldPath, newPath, cred): Promise<void>
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns Promise<void>

Todo
Make rename compatible with the cache.
Overrides BaseFileSystem.rename
- Defined in src/backends/AsyncStore.ts:253

renameSync

renameSync(oldPath, newPath, cred): void
Synchronous rename.
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.renameSync
- Defined in src/filesystem.ts:390

rmdir

rmdir(p, cred): Promise<void>
Asynchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.rmdir
- Defined in src/backends/AsyncStore.ts:370

rmdirSync

rmdirSync(p, cred): void
Synchronous rmdir.
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.rmdirSync
- Defined in src/filesystem.ts:467

stat

stat(p, cred): Promise<Stats>
Asynchronous stat.
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Overrides BaseFileSystem.stat
- Defined in src/backends/AsyncStore.ts:335

statSync

statSync(p, cred): Stats
Synchronous stat.
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from BaseFileSystem.statSync
- Defined in src/filesystem.ts:396

supportsProps

supportsProps(): boolean
Returns boolean
- Defined in src/backends/AsyncStore.ts:220

supportsSymlinks

supportsSymlinks(): boolean
Returns boolean
- Defined in src/backends/AsyncStore.ts:217

supportsSynch

supportsSynch(): boolean
Returns boolean
- Defined in src/backends/AsyncStore.ts:223

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 BaseFileSystem.symlink
- Defined in src/filesystem.ts:654

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 BaseFileSystem.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 BaseFileSystem.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 BaseFileSystem.truncateSync
- Defined in src/filesystem.ts:545

unlink

unlink(p, cred): Promise<void>
Asynchronous unlink.
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Overrides BaseFileSystem.unlink
- Defined in src/backends/AsyncStore.ts:366

unlinkSync

unlinkSync(p, cred): void
Synchronous unlink.
Parameters
- p: string
- cred: Cred
Returns void
Inherited from BaseFileSystem.unlinkSync
- Defined in src/filesystem.ts:461

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 BaseFileSystem.utimes
- Defined in src/filesystem.ts:642

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 BaseFileSystem.utimesSync
- Defined in src/filesystem.ts:645

whenReady

whenReady(): Promise<AsyncKeyValueFileSystem>
Returns Promise<AsyncKeyValueFileSystem>
Inherited from BaseFileSystem.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 BaseFileSystem.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 BaseFileSystem.writeFileSync
- Defined in src/filesystem.ts:595

`Static` isAvailable

isAvailable(): boolean
Returns boolean
- Defined in src/backends/AsyncStore.ts:188

Class AsyncKeyValueFileSystem

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cacheSize: number

Returns AsyncKeyValueFileSystem

Properties

Private _cache

Protected _ready

Protected store

Static Readonly Name

Accessors

metadata

Returns FileSystemMetadata

Methods

Private _findINode

Parameters

tx: AsyncKeyValueROTransaction

parent: string

filename: string

visited: Set<string> = ...

Returns Promise<string>

_sync

Parameters

p: string

data: Uint8Array

stats: Stats

Returns Promise<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: AsyncKeyValueRWTransaction

data: Uint8Array

Returns Promise<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

chown

`Private` _cache

`Protected` _ready

`Protected` store

`Static` `Readonly` Name

`Private` _findINode

`Private` addNewNode

`Private` commitNewFile

`Private` findINode

`Private` getDirListing

Returns Promise<{
[fileName: string]: string;
}>

`Private` getINode