# hashed-fs > Handle file system with content hashing Latest version **2.1.1** (published 2016-12-15) · MIT license · 0 weekly downloads ## Install ```sh npm install hashed-fs pnpm add hashed-fs yarn add hashed-fs bun add hashed-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 | 2.1.1 | | Published | 2016-12-15 | | First published | 2015-10-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=0.10.0 | | Dependencies | 9 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 3 | | Author | kaelzhang | | Maintainers | kael | | Keywords | hashed-fs, fs, file, system, hashed, crypto, cache | ## Links - npm: https://www.npmjs.com/package/hashed-fs - Repository: https://github.com/kaelzhang/node-hashed-fs - Homepage: https://github.com/kaelzhang/node-hashed-fs#readme - Issues: https://github.com/kaelzhang/node-hashed-fs/issues - npm.io page: https://npm.io/package/hashed-fs ## Dependencies (9) - [async](https://npm.io/package/async.md) ^1.5.0 - [clone](https://npm.io/package/clone.md) ^1.0.2 - [fs-extra](https://npm.io/package/fs-extra.md) ^0.24.0 - [lrucache](https://npm.io/package/lrucache.md) ^0.3.0 - [make-array](https://npm.io/package/make-array.md) ^0.1.2 - [async-cache](https://npm.io/package/async-cache.md) ^1.0.0 - [graceful-fs](https://npm.io/package/graceful-fs.md) ^4.1.2 - [object-access](https://npm.io/package/object-access.md) ^1.0.4 - [wrap-as-async](https://npm.io/package/wrap-as-async.md) ^1.0.4 ## 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 - 2.1.1 (latest) — 2016-12-15 - 2.1.0 — 2016-05-19 - 2.0.1 — 2016-05-19 - 2.0.0 — 2016-05-19 - 1.5.5 — 2015-11-25 - 1.5.4 — 2015-11-23 - 1.5.3 — 2015-11-22 - 1.5.2 — 2015-11-22 - 1.5.1 — 2015-11-22 - 1.5.0 — 2015-11-22 - 1.4.3 — 2015-11-21 - 1.4.2 — 2015-11-20 - 1.4.1 — 2015-11-20 - 1.4.0 — 2015-11-20 - 1.3.3 — 2015-11-20 - … 7 more at https://npm.io/package/hashed-fs/versions ## README [![Build Status](https://travis-ci.org/kaelzhang/node-hashed-fs.svg?branch=master)](https://travis-ci.org/kaelzhang/node-hashed-fs) # hashed-fs Gracefully and safely manipulate file with cached content hash. hashed-fs will create hash string from the file content, cache it, and pass it to the callback of each instance method. All hashed-fs instances in one node session will share the same cache. ## Install ```sh $ npm install hashed-fs --save ``` ## Usage ```js var hfs = require('hashed-fs')(options); hfs.stat('/path/to/a.js', function(err, stat, hash){ stat; // is the nodejs `fs.Stat` object hash; // the result hash }); ``` - **options** `Object` - crypto: `function()` method to crypto a file into a `hash` - decorate: `function()` method to decorate the destination filename by flavoring with file `hash`. - cache_file `path=` if specified, hashd-fs will load the cache file at the beginning - only_hashed `Boolean=false` if true, it will only write to the hashed filename. By default, it will write two files. In comparison with the corresponding vanilla `fs` method, each hashed-fs method has an additional parameter `hash` of the callback function, which is the encrypted hash of the file content. #### options.crypto `function(data)` This method is an iterator handler generater which should returns a function. The chunks of the file content, i.e, `data`, will be passed into `options.crypto()` one by one. `data` has the structure below: ```js { value: , // the chunk of data done: // whether is the last chunk of data } ``` If `data.done` is `true`, it means the last chunk of data received, and the `options.crypto` should return the encrypted result. By default, it encrypts the file content using md5 algorithm, but you could specify it by yourself. For example, ```js var crypto = require('crypto'); function sha256 () { var shasum = crypto.createHash('sha256'); return function(data){ if (data.value) { shasum.update(data.value); } if (data.done) { return shasum.digest('hex'); } } } var hfs = require('hashed-fs')({ crypto: sha256 }); ``` #### options.decorate `function(filename, hash)` Defines how `hashed-fs` should add hash string to the filename. It can be synchronous methods or asynchronous ones by using the common [`this.async()`](https://www.npmjs.com/package/wrap-as-async) style. ### hfs.readFile(filename, callback) ```js hfs.readFile('/path/to/a.js', function(err, content, hash){ content; // '// a' hash; // 'ce2e532998ddb06b4334620d74e0d938' }); ``` - **callback** `function(err, content, hash)` - `content` `` - `hash` the `options.crypo()`d hash according to the file content. Reads the file content, and get the stat. ### hfs.copy(filename, dest, callback [, force=false]) - **callback** `function(err, hash)` Copies the file of `filename` to `dest` along with the hash-decorated `dest`. If the file is already in the cache, it will skip copying, except that `force` is `true`. ```js hfs.copy('/path/to/a.js', '/dest/to', function(err, hash){ hash; // 'ce2e532998ddb06b4334620d74e0d938' }); ``` Then the `/dest/to` folder will have **TWO** files: ```sh /dest/to | -- a.js # if options.only_hashed is not true | -- a-ce2e532.js ``` `ce2e532` is the first seven charactors of the `hash`. By changing the default `options.decorate` method, you could define your custom pathname to the destination. ### hfs.stat(filename, callback) - **callback** `function(err, stat, hash, cached)` - `stat` [`fs.Stats`](https://nodejs.org/api/fs.html#fs_class_fs_stats) is the file status of the file - `cached` `Boolean` whether has read from cache. Gets the file stat, and the hashed result. ### hfs.writeFile(filename, content, callback) Similar to `hfs.copy()`, this method will write **TWO** files ### hfs.cache.save(callback) if `options.cache_file` is specified, it will save the cache to the file. ### hfs.cache.map() Returns the `{filename: hash}` object. ## License MIT --- _Source: https://npm.io/package/hashed-fs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._