Class StorageFileSystem

A synchronous file system backed by a Storage (e.g. localStorage).

Hierarchy

SyncKeyValueFileSystem
- StorageFileSystem

Constructors

constructor

new StorageFileSystem(__namedParameters): StorageFileSystem
Creates a new Storage file system using the contents of Storage.
Parameters
- __namedParameters: StorageFileSystem.Options
Returns StorageFileSystem
Overrides SyncKeyValueFileSystem.constructor
- Defined in src/backends/Storage.ts:90

Properties

`Protected` _ready

_ready: Promise<StorageFileSystem>

`Static` Create

Create: any = ...

`Static` `Readonly` Name

Name: "Storage" = 'Storage'

Accessors

metadata

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

Methods

_syncSync

_syncSync(p, data, stats): void
Parameters
- p: string
- data: Uint8Array
- stats: Stats
Returns void
Inherited from SyncKeyValueFileSystem._syncSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:166

access

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

accessSync

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

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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.chmod
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:353

chmodSync

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

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 SyncKeyValueFileSystem.chown
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:354

chownSync

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

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 SyncKeyValueFileSystem.createFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:286

createFileSync

createFileSync(p, flag, mode, cred): SyncKeyValueFile
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns SyncKeyValueFile
Inherited from SyncKeyValueFileSystem.createFileSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:158

empty

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

Returns void
Inherited from SyncKeyValueFileSystem.empty
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:154

exists

exists(p, cred): Promise<boolean>
Parameters
- p: string
- cred: Cred
Returns Promise<boolean>
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.existsSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:316

getName

getName(): string
Returns string
Inherited from SyncKeyValueFileSystem.getName
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:146

isReadOnly

isReadOnly(): boolean
Returns boolean
Inherited from SyncKeyValueFileSystem.isReadOnly
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:147

link

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

linkSync

linkSync(srcpath, dstpath, cred): void
Parameters
- srcpath: string
- dstpath: string
- cred: Cred
Returns void
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.mkdir
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:351

mkdirSync

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

open

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

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 SyncKeyValueFileSystem.openFile
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:281

openFileSync

openFileSync(p, flag, cred): SyncKeyValueFile
Parameters
- p: string
- flag: FileFlag
- cred: Cred
Returns SyncKeyValueFile
Inherited from SyncKeyValueFileSystem.openFileSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:159

openSync

openSync(p, flag, mode, cred): File
Parameters
- p: string
- flag: FileFlag
- mode: number
- cred: Cred
Returns File
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.readdir
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:352

readdirSync

readdirSync(p, cred): string[]
Parameters
- p: string
- cred: Cred
Returns string[]
Inherited from SyncKeyValueFileSystem.readdirSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:163

readlink

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

readlinkSync

readlinkSync(p, cred): string
Parameters
- p: string
- cred: Cred
Returns string
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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>
Inherited from SyncKeyValueFileSystem.rename
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:346

renameSync

renameSync(oldPath, newPath, cred): void
Parameters
- oldPath: string
- newPath: string
- cred: Cred
Returns void
Inherited from SyncKeyValueFileSystem.renameSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:156

rmdir

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

rmdirSync

rmdirSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from SyncKeyValueFileSystem.rmdirSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:161

stat

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

statSync

statSync(p, cred): Stats
Parameters
- p: string
- cred: Cred
Returns Stats
Inherited from SyncKeyValueFileSystem.statSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:157

supportsProps

supportsProps(): boolean
Returns boolean
Inherited from SyncKeyValueFileSystem.supportsProps
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:149

supportsSymlinks

supportsSymlinks(): boolean
Returns boolean
Inherited from SyncKeyValueFileSystem.supportsSymlinks
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:148

supportsSynch

supportsSynch(): boolean
Returns boolean
Inherited from SyncKeyValueFileSystem.supportsSynch
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:150

symlink

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

symlinkSync

symlinkSync(srcpath, dstpath, type, cred): void
Parameters
- srcpath: string
- dstpath: string
- type: string
- cred: Cred
Returns void
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.unlink
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:349

unlinkSync

unlinkSync(p, cred): void
Parameters
- p: string
- cred: Cred
Returns void
Inherited from SyncKeyValueFileSystem.unlinkSync
- Defined in node_modules/@browserfs/core/dist/backends/SyncStore.d.ts:160

utimes

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

utimesSync

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

whenReady

whenReady(): Promise<StorageFileSystem>
Returns Promise<StorageFileSystem>
Inherited from SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.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 SyncKeyValueFileSystem.writeFileSync
- Defined in node_modules/@browserfs/core/dist/filesystem.d.ts:324

`Static` isAvailable

isAvailable(storage?): boolean
Parameters
- storage: Storage = globalThis.localStorage
Returns boolean
Overrides SyncKeyValueFileSystem.isAvailable
- Defined in src/backends/Storage.ts:84

Generated using TypeDoc