# fs-fuse

> Export any Node.js `fs`-like object as a FUSE filesystem

Latest version **0.0.2** (published 2019-12-03) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2019-12-03 |
| First published | 2017-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Jesús Leganés-Combarro 'piranna' |
| Maintainers | piranna |
| Keywords | fs, filesystem, fuse |

## Links

- npm: https://www.npmjs.com/package/fs-fuse
- Repository: https://github.com/piranna/fs-fuse
- Homepage: https://github.com/piranna/fs-fuse#readme
- Issues: https://github.com/piranna/fs-fuse/issues
- npm.io page: https://npm.io/package/fs-fuse

## Dependencies (3)

- [get-stream](https://npm.io/package/get-stream.md) ^5.1.0
- [fuse-bindings](https://npm.io/package/fuse-bindings.md) ^2.11.2
- [parse-mount-argv](https://npm.io/package/parse-mount-argv.md) ^0.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

- 0.0.2 (latest) — 2019-12-03
- 0.0.0 — 2017-05-27

## README

# fs-fuse
Export any Node.js `fs`-like object as a FUSE filesystem

## Node.js `fs` methods

The following `fs` methods' behavior directly maps to corresponding FUSE operations:

`chmod`, `chown`, `fsync`, `ftruncate`, `link`, `mkdir`, `read`, `readdir`,
`readlink`, `rename`, `rmdir`, `symlink`, `truncate`, `unlink`, `write`

Other FUSE operations internally use the following `fs` methods:

FUSE op | `fs` methods
--------|-------------
*wrapFd* | `open`, `close`
*getattr*, *fgetattr* | `stat`, `fstat`, `lstat`
*read* | `createReadStream`
*write* | `createWriteStream`
*release* | `close`
*utimens* | `futimes`, `utimes`

Not all of these fs methods need to be implemented. For example, the file
descriptor ones are not needed if their path based counterparts are implemented,
and viceversa.

## Non standard `FUSE` methods

If available on the `fs` object, the following FUSE compatible methods can be used
too:

`fuse_access`, `create`, `destroy`, `flush`, `fsyncdir`, `getxattr`, `init`,
`listxattr`, `mknod`, `opendir`, `releasedir`, `removexattr`, `setxattr`,
`statfs`

Note that these are FUSE functions and need to have the **EXACT**
signature and behaviour expected by FUSE, which is different from the Node.js `fs` API.

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