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
  - InMemoryFileSystem
  - LocalStorageFileSystem

Index

Constructors

constructor

Methods

Constructors

constructor

new SyncKeyValueFileSystem(options: SyncKeyValueFileSystemOptions): SyncKeyValueFileSystem

- Defined in generic/key_value_filesystem.ts:268
Parameters
- options: SyncKeyValueFileSystemOptions
Returns SyncKeyValueFileSystem

Methods

_syncSync

_syncSync(p: string, data: Buffer, stats: Stats): void

- Defined in generic/key_value_filesystem.ts:403
Parameters
- p: string
- data: Buffer
- stats: Stats
Returns void

appendFile

appendFile(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void

Inherited from BaseFileSystem.appendFile
- Defined in core/file_system.ts:727
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
- cb: BFSOneArgCallback
Returns void

appendFileSync

appendFileSync(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number): void

Inherited from BaseFileSystem.appendFileSync
- Defined in core/file_system.ts:745
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
Returns void

chmod

chmod(p: string, isLchmod: boolean, mode: number, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.chmod

Overrides BaseFileSystem.chmod
- Defined in core/file_system.ts:863
Parameters
- p: string
- isLchmod: boolean
- mode: number
- cb: BFSOneArgCallback
Returns void

chmodSync

chmodSync(p: string, isLchmod: boolean, mode: number): void

Inherited from BaseFileSystem.chmodSync
- Defined in core/file_system.ts:759
Parameters
- p: string
- isLchmod: boolean
- mode: number
Returns void

chown

chown(p: string, isLchown: boolean, uid: number, gid: number, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.chown

Overrides BaseFileSystem.chown
- Defined in core/file_system.ts:872
Parameters
- p: string
- isLchown: boolean
- uid: number
- gid: number
- cb: BFSOneArgCallback
Returns void

chownSync

chownSync(p: string, isLchown: boolean, uid: number, gid: number): void

Inherited from BaseFileSystem.chownSync
- Defined in core/file_system.ts:765
Parameters
- p: string
- isLchown: boolean
- uid: number
- gid: number
Returns void

createFile

createFile(p: string, flag: FileFlag, mode: number, cb: BFSCallback<File>): void

Inherited from BaseFileSystem.createFile
- Defined in core/file_system.ts:404
Create the file at path p with the given mode. Then, open it with the given flag.

Parameters
- p: string
- flag: FileFlag
- mode: number
- cb: BFSCallback<File>
Returns void

createFileSync

createFileSync(p: string, flag: FileFlag, mode: number): File

Overrides BaseFileSystem.createFileSync
- Defined in generic/key_value_filesystem.ts:361
Parameters
- p: string
- flag: FileFlag
- mode: number
Returns File

diskSpace

diskSpace(p: string, cb: function): void

Inherited from BaseFileSystem.diskSpace
- Defined in core/file_system.ts:389
Parameters
- p: string
- cb: function
  - - (total: number, free: number): any
    - Parameters
      - total: number
      - free: number
      Returns any
Returns void

empty

empty(): void

- Defined in generic/key_value_filesystem.ts:286
Delete all contents stored in the file system.

Returns void

exists

exists(p: string, cb: function): void

Inherited from BaseFileSystem.exists
- Defined in core/file_system.ts:558
Parameters
- p: string
- cb: function
  - - (exists: boolean): void
    - Parameters
      - exists: boolean
      Returns void
Returns void

existsSync

existsSync(p: string): boolean

Inherited from BaseFileSystem.existsSync
- Defined in core/file_system.ts:563
Parameters
- p: string
Returns boolean

getName

getName(): string

- Defined in generic/key_value_filesystem.ts:277
Returns string

isReadOnly

isReadOnly(): boolean

- Defined in generic/key_value_filesystem.ts:278
Returns boolean

link

link(srcpath: string, dstpath: string, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.link

Overrides BaseFileSystem.link
- Defined in core/file_system.ts:890
Parameters
- srcpath: string
- dstpath: string
- cb: BFSOneArgCallback
Returns void

linkSync

linkSync(srcpath: string, dstpath: string): void

Inherited from BaseFileSystem.linkSync
- Defined in core/file_system.ts:777
Parameters
- srcpath: string
- dstpath: string
Returns void

mkdir

mkdir(p: string, mode: number, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.mkdir

Overrides BaseFileSystem.mkdir
- Defined in core/file_system.ts:846
Parameters
- p: string
- mode: number
- cb: BFSOneArgCallback
Returns void

mkdirSync

mkdirSync(p: string, mode: number): void

Overrides BaseFileSystem.mkdirSync
- Defined in generic/key_value_filesystem.ts:392
Parameters
- p: string
- mode: number
Returns void

open

open(p: string, flags: FileFlag, mode: number, cb: BFSCallback<File>): void

Inherited from SynchronousFileSystem.open

Overrides BaseFileSystem.open
- Defined in core/file_system.ts:820
Parameters
- p: string
- flags: FileFlag
- mode: number
- cb: BFSCallback<File>
Returns void

openFile

openFile(p: string, flag: FileFlag, cb: BFSCallback<File>): void

Inherited from BaseFileSystem.openFile
- Defined in core/file_system.ts:397
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.
- cb: BFSCallback<File>
Returns void

openFileSync

openFileSync(p: string, flag: FileFlag): File

Overrides BaseFileSystem.openFileSync
- Defined in generic/key_value_filesystem.ts:369
Parameters
- p: string
- flag: FileFlag
Returns File

openSync

openSync(p: string, flag: FileFlag, mode: number): File

Inherited from BaseFileSystem.openSync
- Defined in core/file_system.ts:491
Parameters
- p: string
- flag: FileFlag
- mode: number
Returns File

readFile

readFile(fname: string, encoding: string | null, flag: FileFlag, cb: BFSCallback<string | Buffer>): void

Inherited from BaseFileSystem.readFile
- Defined in core/file_system.ts:635
Parameters
- fname: string
- encoding: string | null
- flag: FileFlag
- cb: BFSCallback<string | Buffer>
Returns void

readFileSync

readFileSync(fname: string, encoding: string | null, flag: FileFlag): any

Inherited from BaseFileSystem.readFileSync
- Defined in core/file_system.ts:672
Parameters
- fname: string
- encoding: string | null
- flag: FileFlag
Returns any

readdir

readdir(p: string, cb: BFSCallback<string[]>): void

Inherited from SynchronousFileSystem.readdir

Overrides BaseFileSystem.readdir
- Defined in core/file_system.ts:855
Parameters
- p: string
- cb: BFSCallback<string[]>
Returns void

readdirSync

readdirSync(p: string): string[]

Overrides BaseFileSystem.readdirSync
- Defined in generic/key_value_filesystem.ts:398
Parameters
- p: string
Returns string[]

readlink

readlink(p: string, cb: BFSCallback<string>): void

Inherited from SynchronousFileSystem.readlink

Overrides BaseFileSystem.readlink
- Defined in core/file_system.ts:908
Parameters
- p: string
- cb: BFSCallback<string>
Returns void

readlinkSync

readlinkSync(p: string): string

Inherited from BaseFileSystem.readlinkSync
- Defined in core/file_system.ts:789
Parameters
- p: string
Returns string

realpath

realpath(p: string, cache: object, cb: BFSCallback<string>): void

Inherited from BaseFileSystem.realpath
- Defined in core/file_system.ts:571
Parameters
- p: string
- cache: object
  - [path: string]: string
- cb: BFSCallback<string>
Returns void

realpathSync

realpathSync(p: string, cache: object): string

Inherited from BaseFileSystem.realpathSync
- Defined in core/file_system.ts:592
Parameters
- p: string
- cache: object
  - [path: string]: string
Returns string

rename

rename(oldPath: string, newPath: string, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.rename

Overrides BaseFileSystem.rename
- Defined in core/file_system.ts:803
Parameters
- oldPath: string
- newPath: string
- cb: BFSOneArgCallback
Returns void

renameSync

renameSync(oldPath: string, newPath: string): void

Overrides BaseFileSystem.renameSync
- Defined in generic/key_value_filesystem.ts:292
Parameters
- oldPath: string
- newPath: string
Returns void

rmdir

rmdir(p: string, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.rmdir

Overrides BaseFileSystem.rmdir
- Defined in core/file_system.ts:837
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

rmdirSync

rmdirSync(p: string): void

Overrides BaseFileSystem.rmdirSync
- Defined in generic/key_value_filesystem.ts:383
Parameters
- p: string
Returns void

stat

stat(p: string, isLstat: boolean | null, cb: BFSCallback<Stats>): void

Inherited from SynchronousFileSystem.stat

Overrides BaseFileSystem.stat
- Defined in core/file_system.ts:812
Parameters
- p: string
- isLstat: boolean | null
- cb: BFSCallback<Stats>
Returns void

statSync

statSync(p: string, isLstat: boolean): Stats

Overrides BaseFileSystem.statSync
- Defined in generic/key_value_filesystem.ts:356
Parameters
- p: string
- isLstat: boolean
Returns Stats

supportsLinks

supportsLinks(): boolean

Inherited from BaseFileSystem.supportsLinks
- Defined in core/file_system.ts:386
Returns boolean

supportsProps

supportsProps(): boolean

- Defined in generic/key_value_filesystem.ts:280
Returns boolean

supportsSymlinks

supportsSymlinks(): boolean

- Defined in generic/key_value_filesystem.ts:279
Returns boolean

supportsSynch

supportsSynch(): boolean

Overrides SynchronousFileSystem.supportsSynch
- Defined in generic/key_value_filesystem.ts:281
Returns boolean

symlink

symlink(srcpath: string, dstpath: string, type: string, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.symlink

Overrides BaseFileSystem.symlink
- Defined in core/file_system.ts:899
Parameters
- srcpath: string
- dstpath: string
- type: string
- cb: BFSOneArgCallback
Returns void

symlinkSync

symlinkSync(srcpath: string, dstpath: string, type: string): void

Inherited from BaseFileSystem.symlinkSync
- Defined in core/file_system.ts:783
Parameters
- srcpath: string
- dstpath: string
- type: string
Returns void

truncate

truncate(p: string, len: number, cb: BFSOneArgCallback): void

Inherited from BaseFileSystem.truncate
- Defined in core/file_system.ts:612
Parameters
- p: string
- len: number
- cb: BFSOneArgCallback
Returns void

truncateSync

truncateSync(p: string, len: number): void

Inherited from BaseFileSystem.truncateSync
- Defined in core/file_system.ts:624
Parameters
- p: string
- len: number
Returns void

unlink

unlink(p: string, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.unlink

Overrides BaseFileSystem.unlink
- Defined in core/file_system.ts:828
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

unlinkSync

unlinkSync(p: string): void

Overrides BaseFileSystem.unlinkSync
- Defined in generic/key_value_filesystem.ts:379
Parameters
- p: string
Returns void

utimes

utimes(p: string, atime: Date, mtime: Date, cb: BFSOneArgCallback): void

Inherited from SynchronousFileSystem.utimes

Overrides BaseFileSystem.utimes
- Defined in core/file_system.ts:881
Parameters
- p: string
- atime: Date
- mtime: Date
- cb: BFSOneArgCallback
Returns void

utimesSync

utimesSync(p: string, atime: Date, mtime: Date): void

Inherited from BaseFileSystem.utimesSync
- Defined in core/file_system.ts:771
Parameters
- p: string
- atime: Date
- mtime: Date
Returns void

writeFile

writeFile(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void

Inherited from BaseFileSystem.writeFile
- Defined in core/file_system.ts:689
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
- cb: BFSOneArgCallback
Returns void

writeFileSync

writeFileSync(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number): void

Inherited from BaseFileSystem.writeFileSync
- Defined in core/file_system.ts:714
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
Returns void

Static isAvailable

isAvailable(): boolean

- Defined in generic/key_value_filesystem.ts:266
Returns boolean

Generated using TypeDoc