HTML5FS | BrowserFS

A read-write filesystem backed by the HTML5 FileSystem API.

As the HTML5 FileSystem is only implemented in Blink, this interface is only available in Chrome.

Hierarchy

BaseFileSystem
- HTML5FS

Implements

FileSystem

Index

Properties

fs
Name

Methods

Object literals

Options

Properties

fs

fs: FileSystem

Static Name

Name: "HTML5FS" = "HTML5FS"

Methods

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

Implementation of FileSystem.chmod

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

chmodSync

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

Implementation of FileSystem.chmodSync

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

Implementation of FileSystem.chown

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

chownSync

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

Implementation of FileSystem.chownSync

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

Inherited from BaseFileSystem.createFileSync
- Defined in core/file_system.ts:488
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:389
Parameters
- p: string
- cb: function
  - - (total: number, free: number): any
    - Parameters
      - total: number
      - free: number
      Returns any
Returns void

empty

empty(mainCb: BFSOneArgCallback): void

- Defined in backend/HTML5FS.ts:225
Deletes everything in the FS. Used for testing. Karma clears the storage after you quit it but not between runs of the test suite, and the tests expect an empty FS every time.

Parameters
- mainCb: BFSOneArgCallback
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

Implementation of FileSystem.existsSync

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

getName

getName(): string

Implementation of FileSystem.getName
- Defined in backend/HTML5FS.ts:200
Returns string

isReadOnly

isReadOnly(): boolean

Implementation of FileSystem.isReadOnly
- Defined in backend/HTML5FS.ts:204
Returns boolean

link

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

Implementation of FileSystem.link

Inherited from BaseFileSystem.link
- Defined in core/file_system.ts:774
Parameters
- srcpath: string
- dstpath: string
- cb: BFSOneArgCallback
Returns void

linkSync

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

Implementation of FileSystem.linkSync

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

mkdir

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

Implementation of FileSystem.mkdir

Overrides BaseFileSystem.mkdir
- Defined in backend/HTML5FS.ts:396
Parameters
- path: string
- mode: number
- cb: BFSOneArgCallback
Returns void

mkdirSync

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

Implementation of FileSystem.mkdirSync

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

open

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

Implementation of FileSystem.open

Overrides BaseFileSystem.open
- Defined in backend/HTML5FS.ts:350
Parameters
- p: string
- flags: FileFlag
- mode: number
- cb: BFSCallback<IFile>
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, mode: number): File

Inherited from BaseFileSystem.openFileSync
- Defined in core/file_system.ts:481
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

Implementation of FileSystem.openSync

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

Implementation of FileSystem.readFile

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

Implementation of FileSystem.readFileSync

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

readdir

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

Implementation of FileSystem.readdir

Overrides BaseFileSystem.readdir
- Defined in backend/HTML5FS.ts:415
Map _readdir's list of FileEntrys to their names and return that.

Parameters
- path: string
- cb: BFSCallback<string[]>
Returns void

readdirSync

readdirSync(p: string): string[]

Implementation of FileSystem.readdirSync

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

readlink

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

Implementation of FileSystem.readlink

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

readlinkSync

readlinkSync(p: string): string

Implementation of FileSystem.readlinkSync

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

Implementation of FileSystem.rename

Overrides BaseFileSystem.rename
- Defined in backend/HTML5FS.ts:260
Parameters
- oldPath: string
- newPath: string
- cb: BFSOneArgCallback
Returns void

renameSync

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

Implementation of FileSystem.renameSync

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

rmdir

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

Implementation of FileSystem.rmdir

Overrides BaseFileSystem.rmdir
- Defined in backend/HTML5FS.ts:383
Parameters
- path: string
- cb: BFSOneArgCallback
Returns void

rmdirSync

rmdirSync(p: string): void

Implementation of FileSystem.rmdirSync

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

stat

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

Overrides BaseFileSystem.stat
- Defined in backend/HTML5FS.ts:313
Parameters
- path: string
- isLstat: boolean
- cb: BFSCallback<Stats>
Returns void

statSync

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

Implementation of FileSystem.statSync

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

supportsLinks

supportsLinks(): boolean

Implementation of FileSystem.supportsLinks

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

supportsProps

supportsProps(): boolean

Implementation of FileSystem.supportsProps
- Defined in backend/HTML5FS.ts:212
Returns boolean

supportsSymlinks

supportsSymlinks(): boolean

- Defined in backend/HTML5FS.ts:208
Returns boolean

supportsSynch

supportsSynch(): boolean

Implementation of FileSystem.supportsSynch
- Defined in backend/HTML5FS.ts:216
Returns boolean

symlink

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

Implementation of FileSystem.symlink

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

symlinkSync

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

Implementation of FileSystem.symlinkSync

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

Implementation of FileSystem.truncate

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

Implementation of FileSystem.truncateSync

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

unlink

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

Implementation of FileSystem.unlink

Overrides BaseFileSystem.unlink
- Defined in backend/HTML5FS.ts:379
Parameters
- path: string
- cb: BFSOneArgCallback
Returns void

unlinkSync

unlinkSync(p: string): void

Implementation of FileSystem.unlinkSync

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

utimes

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

Implementation of FileSystem.utimes

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

utimesSync

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

Implementation of FileSystem.utimesSync

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

Implementation of FileSystem.writeFile

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 Create

Create(opts: HTML5FSOptions, cb: BFSCallback<HTML5FS>): void

- Defined in backend/HTML5FS.ts:177
Creates an HTML5FS instance with the given options.

Parameters
- opts: HTML5FSOptions
- cb: BFSCallback<HTML5FS>
Returns void

Static isAvailable

isAvailable(): boolean

- Defined in backend/HTML5FS.ts:181
Returns boolean

Object literals

Static Options

Options: object

size

size: object

description

description: string = "Storage quota to request, in megabytes. Allocated value may be less. Defaults to 5."

optional

optional: boolean = true

type

type: string = "number"

type

type: object

description

description: string = "window.PERSISTENT or window.TEMPORARY. Defaults to PERSISTENT."

optional

optional: boolean = true

type

type: string = "number"

Hierarchy

Implements

Index

Properties

Methods

Object literals

Properties

fs

Static Name

Methods

appendFile

Parameters

fname: string

data: any

encoding: string | null

flag: FileFlag

mode: number

cb: BFSOneArgCallback

Returns void

appendFileSync

Parameters

fname: string

data: any

encoding: string | null

flag: FileFlag

mode: number

Returns void

chmod

Parameters

p: string

isLchmod: boolean

mode: number

cb: BFSOneArgCallback

Returns void

chmodSync

Parameters

p: string

isLchmod: boolean

mode: number

Returns void

chown

Parameters

p: string

isLchown: boolean

uid: number

gid: number

cb: BFSOneArgCallback

Returns void

chownSync

Parameters

p: string

isLchown: boolean

uid: number

gid: number

Returns void

createFile

Parameters

p: string

flag: FileFlag

mode: number

cb: BFSCallback<File>

Returns void

createFileSync

Parameters

p: string

flag: FileFlag

mode: number

Returns File

diskSpace

Parameters

p: string

cb: function

Parameters

total: number

free: number

Returns any

Returns void

empty

Parameters

mainCb: BFSOneArgCallback