Interface BrowserFS

BrowserFS's main interface.

In the browser, this is exposed as the BrowserFS global.

In node, this is the object you receive when you require('browserfs').

Hierarchy

BrowserFS

Index

Properties

Methods

Properties

BFSRequire

BFSRequire: BFSRequire

Emulates Node's require() function for filesystem-related modules ('fs', 'path', 'buffer', etc).

FileSystem

FileSystem: object

Exposes all of the file system backends available in BrowserFS.

Type declaration

AsyncMirror: AsyncMirror
Dropbox: DropboxFileSystem
Emscripten: EmscriptenFileSystem
FolderAdapter: FolderAdapter
HTML5FS: HTML5FS
HTTPRequest: HTTPRequest
InMemory: InMemoryFileSystem
IndexedDB: IndexedDBFileSystem
IsoFS: IsoFS
LocalStorage: LocalStorageFileSystem
MountableFileSystem: MountableFileSystem
OverlayFS: OverlayFS
WorkerFS: WorkerFS
XmlHttpRequest: HTTPRequest
ZipFS: ZipFS

Methods

initialize

initialize(rootFS: FileSystem): void

- Defined in typedoc.ts:33
You must call this function with a properly-instantiated root file system before using any file system API method.

Parameters
- rootFS: FileSystem
  
  The root filesystem to use for the entire BrowserFS file system.
Returns void

install

install(obj: any): void

- Defined in typedoc.ts:48
Installs BrowserFS onto the given object. We recommend that you run install with the 'window' object to make things global, as in Node.

Properties installed:
- Buffer
- process
- require (we monkey-patch it)
This allows you to write code as if you were running inside Node.
Parameters
- obj: any
  
  The object to install things onto (e.g. window)
Returns void

Generated using TypeDoc