Class IndexedDBFileSystem

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

Hierarchy

AsyncKeyValueFileSystem
- IndexedDBFileSystem

Constructors

constructor

new IndexedDBFileSystem(__namedParameters): IndexedDBFileSystem
Parameters
- __namedParameters: IndexedDBFileSystem.Options
Returns IndexedDBFileSystem
Overrides AsyncKeyValueFileSystem.constructor
- Defined in src/backends/IndexedDB.ts:246

Properties

`Protected` _ready

_ready: Promise<IndexedDBFileSystem>

`Protected` store

store: AsyncKeyValueStore

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "IndexedDB" = 'IndexedDB'

Accessors

metadata

get metadata(): FileSystemMetadata
Returns FileSystemMetadata
Inherited from AsyncKeyValueFileSystem.metadata
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:274

Methods

_sync

_sync(p, data, stats): Promise<void>
Parameters
- p: string
- data: Uint8Array
- stats: Stats
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem._sync
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:106

access

access(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.access
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:92

accessSync

accessSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.accessSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:289

appendFile

appendFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.appendFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:325

appendFileSync

appendFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.appendFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:326

chmod

chmod(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.chmod
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:104

chmodSync

chmodSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.chmodSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:328

chown

chown(p, new_uid, new_gid, cred): Promise<void>
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.chown
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:105

chownSync

chownSync(p, new_uid, new_gid, cred): void
Parameters
- p: string
- new_uid: number
- new_gid: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.chownSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:330

createFile

createFile(p, flag, mode, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Inherited from AsyncKeyValueFileSystem.createFile
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:98

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 AsyncKeyValueFileSystem.createFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:305

empty

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

Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.empty
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:91

exists

exists(p, cred): Promise<boolean>
Parameters
- p: string
- cred: Cred
Returns Promise<boolean>
Inherited from AsyncKeyValueFileSystem.exists
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:315

existsSync

existsSync(p, cred): boolean
Parameters
- p: string
- cred: Cred
Returns boolean
Inherited from AsyncKeyValueFileSystem.existsSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:316

getName

getName(): string
Returns string
Inherited from AsyncKeyValueFileSystem.getName
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:83

init

init(store): Promise<void>
Initializes the file system. Typically called by subclasses' async constructors.
Parameters
- store: AsyncKeyValueStore
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.init
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:82

isReadOnly

isReadOnly(): boolean
Returns boolean
Inherited from AsyncKeyValueFileSystem.isReadOnly
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:84

link

link(srcpath, dstpath, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.link
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:333

linkSync

linkSync(srcpath, dstpath, cred): void
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.linkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:334

mkdir

mkdir(p, mode, cred): Promise<void>
Parameters
- p: string
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.mkdir
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:102

mkdirSync

mkdirSync(p, mode, cred): void
Parameters
- p: string
- mode: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.mkdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:312

open

open(p, flag, mode, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<File>
Inherited from AsyncKeyValueFileSystem.open
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:287

openFile

openFile(p, flag, cred): Promise<File>
Parameters
- p: string
- flag: FileFlag
- cred: Cred
Returns Promise<File>
Inherited from AsyncKeyValueFileSystem.openFile
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:99

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 AsyncKeyValueFileSystem.openFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:300

openSync

openSync(p, flag, mode, cred): File
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns File
Inherited from AsyncKeyValueFileSystem.openSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:306

readFile

readFile(fname, flag, cred): Promise<Uint8Array>
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Promise<Uint8Array>
Inherited from AsyncKeyValueFileSystem.readFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:321

readFileSync

readFileSync(fname, flag, cred): Uint8Array
Parameters
- fname: string
- flag: FileFlag
- cred: Cred
Returns Uint8Array
Inherited from AsyncKeyValueFileSystem.readFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:322

readdir

readdir(p, cred): Promise<string[]>
Parameters
- p: string
- cred: Cred
Returns Promise<string[]>
Inherited from AsyncKeyValueFileSystem.readdir
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:103

readdirSync

readdirSync(p, cred): string[]
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from AsyncKeyValueFileSystem.readdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:314

readlink

readlink(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from AsyncKeyValueFileSystem.readlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:337

readlinkSync

readlinkSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from AsyncKeyValueFileSystem.readlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:338

realpath

realpath(p, cred): Promise<string>
Parameters
- p: string
- cred: Cred
Returns Promise<string>
Inherited from AsyncKeyValueFileSystem.realpath
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:317

realpathSync

realpathSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from AsyncKeyValueFileSystem.realpathSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:318

rename

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

Todo
Make rename compatible with the cache.
Inherited from AsyncKeyValueFileSystem.rename
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:96

renameSync

renameSync(oldPath, newPath, cred): void
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.renameSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:291

rmdir

rmdir(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.rmdir
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:101

rmdirSync

rmdirSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.rmdirSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:310

stat

stat(p, cred): Promise<Stats>
Parameters
- p: string
- cred: Cred
Returns Promise<Stats>
Inherited from AsyncKeyValueFileSystem.stat
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:97

statSync

statSync(p, cred): Stats
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from AsyncKeyValueFileSystem.statSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:293

supportsProps

supportsProps(): boolean
Returns boolean
Inherited from AsyncKeyValueFileSystem.supportsProps
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:86

supportsSymlinks

supportsSymlinks(): boolean
Returns boolean
Inherited from AsyncKeyValueFileSystem.supportsSymlinks
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:85

supportsSynch

supportsSynch(): boolean
Returns boolean
Inherited from AsyncKeyValueFileSystem.supportsSynch
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:87

symlink

symlink(srcpath, dstpath, type, cred): Promise<void>
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.symlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:335

symlinkSync

symlinkSync(srcpath, dstpath, type, cred): void
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.symlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:336

truncate

truncate(p, len, cred): Promise<void>
Parameters
- p: string
- len: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.truncate
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:319

truncateSync

truncateSync(p, len, cred): void
Parameters
- p: string
- len: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.truncateSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:320

unlink

unlink(p, cred): Promise<void>
Parameters
- p: string
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.unlink
- Defined in node_modules/@browserfs/core/dist/backends/AsyncStore.d.ts:100

unlinkSync

unlinkSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.unlinkSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:308

utimes

utimes(p, atime, mtime, cred): Promise<void>
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.utimes
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:331

utimesSync

utimesSync(p, atime, mtime, cred): void
Parameters
- p: string
- atime: Date
- mtime: Date
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.utimesSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:332

whenReady

whenReady(): Promise<IndexedDBFileSystem>
Returns Promise<IndexedDBFileSystem>
Inherited from AsyncKeyValueFileSystem.whenReady
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:275

writeFile

writeFile(fname, data, flag, mode, cred): Promise<void>
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns Promise<void>
Inherited from AsyncKeyValueFileSystem.writeFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:323

writeFileSync

writeFileSync(fname, data, flag, mode, cred): void
Parameters
- fname: string
- data: Uint8Array
- flag: FileFlag
- mode: number
- cred: Cred
Returns void
Inherited from AsyncKeyValueFileSystem.writeFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:324

`Static` isAvailable

isAvailable(idbFactory?): boolean
Parameters
- idbFactory: IDBFactory = globalThis.indexedDB
Returns boolean
Overrides AsyncKeyValueFileSystem.isAvailable
- Defined in src/backends/IndexedDB.ts:232

Generated using TypeDoc