# browserify-fs

> fs for the browser using level-filesystem and browserify

Latest version **1.0.0** (published 2014-04-14) · 0 weekly downloads

## Install

```sh
npm install browserify-fs
pnpm add browserify-fs
yarn add browserify-fs
bun add browserify-fs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2014-04-14 |
| First published | 2014-04-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 188 |
| Maintainers | mafintosh |
| Keywords | browserify, fs, level, filesystem |

## Links

- npm: https://www.npmjs.com/package/browserify-fs
- Repository: https://github.com/mafintosh/browserify-fs
- Issues: https://github.com/mafintosh/browserify-fs/issues
- npm.io page: https://npm.io/package/browserify-fs

## Dependencies (3)

- [levelup](https://npm.io/package/levelup.md) ^0.18.2
- [level-js](https://npm.io/package/level-js.md) ^2.1.3
- [level-filesystem](https://npm.io/package/level-filesystem.md) ^1.0.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2014-04-14

## README

# browserify-fs

[fs](http://nodejs.org/api/fs.html) for the browser using [level-filesystem](https://github.com/mafintosh/level-filesystem) and [browserify](https://github.com/substack/node-browserify)

	npm install browserify-fs

## Usage

To use simply require it and use it as you would fs

``` js
var fs = require('browserify-fs');

fs.mkdir('/home', function() {
	fs.writeFile('/home/hello-world.txt', 'Hello world!\n', function() {
		fs.readFile('/home/hello-world.txt', 'utf-8', function(err, data) {
			console.log(data);
		});
	});
});
```

You can also make browserify replace `require('fs')` with browserify-fs using

	browserify -r fs:browserify-fs

Using the replacement you browserify modules like [tar-fs](https://github.com/mafintosh/tar-fs) and [mkdirp](https://github.com/substack/node-mkdirp)!

Checkout [level-filesystem](https://github.com/mafintosh/level-filesystem) to see which browsers are supported

## License

MIT

---
_Source: https://npm.io/package/browserify-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._