Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalets/bro-fs
Promise-based HTML5 Filesystem API similar to Node.js fs module
https://github.com/vitalets/bro-fs
filesystem-api html5-filesystem-api
Last synced: about 1 month ago
JSON representation
Promise-based HTML5 Filesystem API similar to Node.js fs module
- Host: GitHub
- URL: https://github.com/vitalets/bro-fs
- Owner: vitalets
- Created: 2016-10-23T20:12:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-16T01:50:46.000Z (over 4 years ago)
- Last Synced: 2024-10-03T12:23:57.869Z (2 months ago)
- Topics: filesystem-api, html5-filesystem-api
- Language: JavaScript
- Homepage: https://vitalets.github.io/bro-fs
- Size: 778 KB
- Stars: 43
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-browser-extensions-and-apps - bro-fs - Promise-based [HTML5 Filesystem API](https://dev.w3.org/2009/dap/file-system/file-dir-sys.html) allowing to work with sandboxed filesystem in browser. (Tools / Development)
README
# bro-fs
[](https://travis-ci.org/vitalets/bro-fs)
[](https://saucelabs.com/u/browserfilesystem)
[](https://www.npmjs.com/package/bro-fs)
[](https://www.npmjs.com/package/bro-fs)
Promise-based wrapper over [HTML5 Filesystem API](https://dev.w3.org/2009/dap/file-system/file-dir-sys.html)
allowing to work with sandboxed filesystem in browser.
API is similar to [Node.js fs module](https://nodejs.org/api/fs.html) with some extra sugar.
Currently it is supported [only by Chrome](https://developer.mozilla.org/en-US/docs/Web/API/FileSystem#Browser_compatibility).
Tested in:
[](https://saucelabs.com/u/browserfilesystem)
## Demos
* [Live Demo](https://vitalets.github.io/bro-fs/demo/)
* [jsFiddle](https://jsfiddle.net/na0m8om8/3/)
## API
* [API Documentaion](https://vitalets.github.io/bro-fs/)
## Install
* install from npm:
```bash
npm install bro-fs
```
* include directly from CDN via `` tag:
```html
<script src="https://unpkg.com/bro-fs">
```
* download manually the [latest release]((https://github.com/vitalets/bro-fs/releases/latest))
## Usage
With `async/await`:
```js
const fs = require('bro-fs');
(async function () {
await fs.init({type: window.TEMPORARY, bytes: 5 * 1024 * 1024});
await fs.mkdir('dir');
await fs.writeFile('dir/file.txt', 'hello world');
const content = await fs.readFile('dir/file.txt');
console.log(content); // => "hello world"
})();
```
or with `.then()`:
```js
fs.init({type: window.TEMPORARY, bytes: 5 * 1024 * 1024})
.then(() => fs.mkdir('dir'))
.then(() => fs.writeFile('dir/file.txt', 'hello world'))
.then(() => fs.readFile('dir/file.txt'))
.then(content => console.log(content)); // => "hello world"
```
See more usage examples in [test directory](/test).
## W3C Specs
Current:
* [https://dev.w3.org/2009/dap/file-system/file-dir-sys.html](https://dev.w3.org/2009/dap/file-system/file-dir-sys.html) (Chrome)
* [https://wicg.github.io/entries-api](https://wicg.github.io/entries-api) (Firefox and Edge)
Coming (draft):
* [https://w3c.github.io/filesystem-api](https://w3c.github.io/filesystem-api)
Discussion:
* [https://github.com/w3c/filesystem-api/issues/8](https://github.com/w3c/filesystem-api/issues/8)
## Similar packages
* [filer.js](https://www.npmjs.com/package/filer.js) - unix-like commands, callbacks
* [html5-fs](https://github.com/evanshortiss/html5-fs) - looks obsolete, callbacks
* [chromestore.js](https://github.com/summera/chromestore.js) - looks obsolete, callbacks
* [BrowserFS](https://github.com/jvilk/BrowserFS) - many backends, callbacks
* [fs-web](https://www.npmjs.com/package/fs-web) - store files in IndexedDB, not html5 filesystem
* [web-fs](https://github.com/mmckegg/web-fs) - abandoned
* [browserify-fs](https://github.com/mafintosh/browserify-fs) - uses leveldb under hood, callbacks
* [fs-browserify](https://github.com/CrabDude/fs-browserify) - abandoned
* [dom-fs](https://www.npmjs.com/package/dom-fs) - abandoned
## License
MIT @ [Vitaliy Potapov](https://github.com/vitalets)