Class HTML5FS

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

Constructors

constructor

Properties

fs

Methods

Constructors

constructor

new HTML5FS(size?: number, type?: number, deprecateMsg?: boolean): HTML5FS

- Defined in backend/HTML5FS.ts:173
Deprecated. Please use HTML5FS.Create() method instead.

Creates a new HTML5 FileSystem-backed BrowserFS file system of the given size and storage type.

IMPORTANT: You must call allocate on the resulting object before the file system can be used.

Parameters
- Default value size: number = 5
  
  storage quota to request, in megabytes. Allocated value may be less.
- Default value type: number = global.PERSISTENT
  
  window.PERSISTENT or window.TEMPORARY. Defaults to PERSISTENT.
- Default value deprecateMsg: boolean = true
Returns HTML5FS

Properties

fs

fs: FileSystem

Methods

allocate

allocate(cb?: BFSOneArgCallback, deprecateMsg?: boolean): void

- Defined in backend/HTML5FS.ts:220
Deprecated. Please use Create() method instead to create and allocate an HTML5FS.

Requests a storage quota from the browser to back this FS. Must be called before file system can be used!

Parameters
- Default value cb: BFSOneArgCallback = () => {/*nop*/}
- Default value deprecateMsg: boolean = true
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

Implementation of FileSystem.chmod

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

Implementation of FileSystem.chmodSync

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

Implementation of FileSystem.chown

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

Implementation of FileSystem.chownSync

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 BaseFileSystem.createFile
- Defined in core/file_system.ts:371
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: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(mainCb: BFSOneArgCallback): void

- Defined in backend/HTML5FS.ts:245
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:525
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:530
Parameters
- p: string
Returns boolean

getName

getName(): string

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

isReadOnly

isReadOnly(): boolean

Implementation of FileSystem.isReadOnly
- Defined in backend/HTML5FS.ts:198
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:741
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:744
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:418
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:516
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:372
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:364
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: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

Implementation of FileSystem.openSync

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

Implementation of FileSystem.readFile

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

Implementation of FileSystem.readFileSync

Inherited from BaseFileSystem.readFileSync
- Defined in core/file_system.ts:639
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:437
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:522
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:753
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: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

Implementation of FileSystem.rename

Overrides BaseFileSystem.rename
- Defined in backend/HTML5FS.ts:282
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:433
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:405
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:510
Parameters
- p: string
Returns void

stat

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

Overrides BaseFileSystem.stat
- Defined in backend/HTML5FS.ts:335
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:439
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:353
Returns boolean

supportsProps

supportsProps(): boolean

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

supportsSymlinks

supportsSymlinks(): boolean

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

supportsSynch

supportsSynch(): boolean

Implementation of FileSystem.supportsSynch
- Defined in backend/HTML5FS.ts:210
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:747
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:750
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:579
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:591
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:401
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:504
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:735
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: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

Implementation of FileSystem.writeFile

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(opts: HTML5FSOptions, cb: BFSCallback<HTML5FS>): void

- Defined in backend/HTML5FS.ts:162
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:166
Returns boolean

Generated using TypeDoc