diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:10:37 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-24 15:11:17 +0200 |
commit | 7a3df06eb573d36142bd1a8e03c5ce8752d300b3 (patch) | |
tree | 70bfaea8884c374876f607774850a3a51c0cb381 /node_modules/hash-base/README.md | |
parent | aca1143cb9eed16cf37f04e475e4257418dd18ac (diff) |
fix build issues and add typedoc
Diffstat (limited to 'node_modules/hash-base/README.md')
-rw-r--r-- | node_modules/hash-base/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/node_modules/hash-base/README.md b/node_modules/hash-base/README.md new file mode 100644 index 000000000..2fa8f1d23 --- /dev/null +++ b/node_modules/hash-base/README.md @@ -0,0 +1,38 @@ +# hash-base + +[](https://www.npmjs.org/package/hash-base) +[](https://travis-ci.org/crypto-browserify/hash-base) +[](https://david-dm.org/crypto-browserify/hash-base#info=dependencies) + +[](https://github.com/feross/standard) + +Abstract base class to inherit from if you want to create streams implementing the same API as node crypto [Hash][1] (for [Cipher][2] / [Decipher][3] check [crypto-browserify/cipher-base][4]). + +## Example + +```js +function MyHash () { + HashBase.call(64) // in bytes +} + +inherti(MyHash, HashBase) + +MyHash.prototype._update = function () { + // hashing one block with buffer this._block +} + +MyHash.prototype._digest = function () { + // create padding and produce result +} +``` +You also can check [source code](index.js) or [crypto-browserify/md5.js][5] + +## LICENSE + +MIT + +[1]: https://nodejs.org/api/crypto.html#crypto_class_hash +[2]: https://nodejs.org/api/crypto.html#crypto_class_cipher +[3]: https://nodejs.org/api/crypto.html#crypto_class_decipher +[4]: https://github.com/crypto-browserify/cipher-base +[5]: https://github.com/crypto-browserify/md5.js |