Class IndexedDBFileSystem

A file system that uses the IndexedDB key value file system.

Hierarchy

AsyncKeyValueFileSystem
- IndexedDBFileSystem

Index

Constructors

constructor

Properties

store

Methods

Constructors

constructor

new IndexedDBFileSystem(cb: BFSCallback<IndexedDBFileSystem>, storeName?: string, deprecateMsg?: boolean): IndexedDBFileSystem

- Defined in backend/IndexedDB.ts:225
Deprecated. Use IndexedDB.Create() method instead.

Constructs an IndexedDB file system.

Parameters
- cb: BFSCallback<IndexedDBFileSystem>
  
  Called once the database is instantiated and ready for use. Passes an error if there was an issue instantiating the database.
- Optional storeName: string
  
  The name of this file system. You can have multiple IndexedDB file systems operating at once, but each must have a different name.
- Default value deprecateMsg: boolean = true
Returns IndexedDBFileSystem

Properties

Protected store

store: AsyncKeyValueStore

Methods

_sync

_sync(p: string, data: Buffer, stats: Stats, cb: BFSOneArgCallback): void

Inherited from AsyncKeyValueFileSystem._sync
- Defined in generic/key_value_filesystem.ts:945
Parameters
- p: string
- data: Buffer
- stats: Stats
- cb: BFSOneArgCallback
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:694
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:712
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 BaseFileSystem.chmod
- Defined in core/file_system.ts:723
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:726
Parameters
- p: string
- isLchmod: boolean
- mode: number
Returns void

chown

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

Inherited from BaseFileSystem.chown
- Defined in core/file_system.ts:729
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:732
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 AsyncKeyValueFileSystem.createFile

Overrides BaseFileSystem.createFile
- Defined in generic/key_value_filesystem.ts:879
Parameters
- p: string
- flag: FileFlag
- mode: number
- cb: BFSCallback<File>
Returns void

createFileSync

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

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

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:356
Parameters
- p: string
- cb: function
  - - (total: number, free: number): any
    - Parameters
      - total: number
      - free: number
      Returns any
Returns void

empty

empty(cb: BFSOneArgCallback): void

Inherited from AsyncKeyValueFileSystem.empty
- Defined in generic/key_value_filesystem.ts:743
Delete all contents stored in the file system.

Parameters
- cb: BFSOneArgCallback
Returns void

exists

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

Inherited from BaseFileSystem.exists
- Defined in core/file_system.ts:525
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:530
Parameters
- p: string
Returns boolean

getName

getName(): string

Inherited from AsyncKeyValueFileSystem.getName
- Defined in generic/key_value_filesystem.ts:734
Returns string

init

init(store: AsyncKeyValueStore, cb: BFSOneArgCallback): void

Inherited from AsyncKeyValueFileSystem.init
- Defined in generic/key_value_filesystem.ts:729
Initializes the file system. Typically called by subclasses' async constructors.

Parameters
- store: AsyncKeyValueStore
- cb: BFSOneArgCallback
Returns void

isReadOnly

isReadOnly(): boolean

Inherited from AsyncKeyValueFileSystem.isReadOnly
- Defined in generic/key_value_filesystem.ts:735
Returns boolean

link

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

Inherited from BaseFileSystem.link
- Defined in core/file_system.ts:741
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:744
Parameters
- srcpath: string
- dstpath: string
Returns void

mkdir

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

Inherited from AsyncKeyValueFileSystem.mkdir

Overrides BaseFileSystem.mkdir
- Defined in generic/key_value_filesystem.ts:926
Parameters
- p: string
- mode: number
- cb: BFSOneArgCallback
Returns void

mkdirSync

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

Inherited from BaseFileSystem.mkdirSync
- Defined in core/file_system.ts:516
Parameters
- p: string
- mode: number
Returns void

open

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

Inherited from BaseFileSystem.open
- Defined in core/file_system.ts:374
Parameters
- p: string
- flag: FileFlag
- mode: number
- cb: BFSCallback<File>
Returns void

openFile

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

Inherited from AsyncKeyValueFileSystem.openFile

Overrides BaseFileSystem.openFile
- Defined in generic/key_value_filesystem.ts:890
Parameters
- p: string
- flag: FileFlag
- cb: BFSCallback<File>
Returns void

openFileSync

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

Inherited from BaseFileSystem.openFileSync
- Defined in core/file_system.ts:448
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.
- mode: number
Returns File

A File object corresponding to the opened file.

openSync

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

Inherited from BaseFileSystem.openSync
- Defined in core/file_system.ts:458
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:602
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:639
Parameters
- fname: string
- encoding: string | null
- flag: FileFlag
Returns any

readdir

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

Inherited from AsyncKeyValueFileSystem.readdir

Overrides BaseFileSystem.readdir
- Defined in generic/key_value_filesystem.ts:932
Parameters
- p: string
- cb: BFSCallback<string[]>
Returns void

readdirSync

readdirSync(p: string): string[]

Inherited from BaseFileSystem.readdirSync
- Defined in core/file_system.ts:522
Parameters
- p: string
Returns string[]

readlink

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

Inherited from BaseFileSystem.readlink
- Defined in core/file_system.ts:753
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

readlinkSync

readlinkSync(p: string): string

Inherited from BaseFileSystem.readlinkSync
- Defined in core/file_system.ts:756
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:538
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:559
Parameters
- p: string
- cache: object
  - [path: string]: string
Returns string

rename

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

Inherited from AsyncKeyValueFileSystem.rename

Overrides BaseFileSystem.rename
- Defined in generic/key_value_filesystem.ts:752
Parameters
- oldPath: string
- newPath: string
- cb: BFSOneArgCallback
Returns void

renameSync

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

Inherited from BaseFileSystem.renameSync
- Defined in core/file_system.ts:433
Parameters
- oldPath: string
- newPath: string
Returns void

rmdir

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

Inherited from AsyncKeyValueFileSystem.rmdir

Overrides BaseFileSystem.rmdir
- Defined in generic/key_value_filesystem.ts:913
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

rmdirSync

rmdirSync(p: string): void

Inherited from BaseFileSystem.rmdirSync
- Defined in core/file_system.ts:510
Parameters
- p: string
Returns void

stat

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

Inherited from AsyncKeyValueFileSystem.stat

Overrides BaseFileSystem.stat
- Defined in generic/key_value_filesystem.ts:870
Parameters
- p: string
- isLstat: boolean
- cb: BFSCallback<Stats>
Returns void

statSync

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

Inherited from BaseFileSystem.statSync
- Defined in core/file_system.ts:439
Parameters
- p: string
- isLstat: boolean | null
Returns Stats

supportsLinks

supportsLinks(): boolean

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

supportsProps

supportsProps(): boolean

Inherited from AsyncKeyValueFileSystem.supportsProps
- Defined in generic/key_value_filesystem.ts:737
Returns boolean

supportsSymlinks

supportsSymlinks(): boolean

Inherited from AsyncKeyValueFileSystem.supportsSymlinks
- Defined in generic/key_value_filesystem.ts:736
Returns boolean

supportsSynch

supportsSynch(): boolean

Inherited from AsyncKeyValueFileSystem.supportsSynch
- Defined in generic/key_value_filesystem.ts:738
Returns boolean

symlink

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

Inherited from BaseFileSystem.symlink
- Defined in core/file_system.ts:747
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:750
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:579
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:591
Parameters
- p: string
- len: number
Returns void

unlink

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

Inherited from AsyncKeyValueFileSystem.unlink

Overrides BaseFileSystem.unlink
- Defined in generic/key_value_filesystem.ts:909
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

unlinkSync

unlinkSync(p: string): void

Inherited from BaseFileSystem.unlinkSync
- Defined in core/file_system.ts:504
Parameters
- p: string
Returns void

utimes

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

Inherited from BaseFileSystem.utimes
- Defined in core/file_system.ts:735
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:738
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:656
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:681
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
Returns void

Static Create

Create(cb: BFSCallback<IndexedDBFileSystem>): void
Create(opts: IndexedDBFileSystemOptions, cb: BFSCallback<IndexedDBFileSystem>): void

- Defined in backend/IndexedDB.ts:207
Constructs an IndexedDB file system with the given options.

Parameters
- cb: BFSCallback<IndexedDBFileSystem>
Returns void
- Defined in backend/IndexedDB.ts:208
Parameters
- opts: IndexedDBFileSystemOptions
- cb: BFSCallback<IndexedDBFileSystem>
Returns void

Static isAvailable

isAvailable(): boolean

Overrides AsyncKeyValueFileSystem.isAvailable
- Defined in backend/IndexedDB.ts:215
Returns boolean

Generated using TypeDoc