summaryrefslogtreecommitdiffstats
path: root/node_modules/cipher-base/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-16 00:10:28 +0100
commite06ec920f7a5d784e674c4c4b4e6d1da3dc7391d (patch)
tree55713f725f77b44ebfec86e4eec3ce33e71458ca /node_modules/cipher-base/README.md
downloadwebsite_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.gz
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.tar.bz2
website_creator-e06ec920f7a5d784e674c4c4b4e6d1da3dc7391d.zip
api, login, auth
Diffstat (limited to 'node_modules/cipher-base/README.md')
-rw-r--r--node_modules/cipher-base/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/node_modules/cipher-base/README.md b/node_modules/cipher-base/README.md
new file mode 100644
index 0000000..db9a781
--- /dev/null
+++ b/node_modules/cipher-base/README.md
@@ -0,0 +1,17 @@
+cipher-base
+===
+
+[![Build Status](https://travis-ci.org/crypto-browserify/cipher-base.svg)](https://travis-ci.org/crypto-browserify/cipher-base)
+
+Abstract base class to inherit from if you want to create streams implementing
+the same api as node crypto streams.
+
+Requires you to implement 2 methods `_final` and `_update`. `_update` takes a
+buffer and should return a buffer, `_final` takes no arguments and should return
+a buffer.
+
+
+The constructor takes one argument and that is a string which if present switches
+it into hash mode, i.e. the object you get from crypto.createHash or
+crypto.createSign, this switches the name of the final method to be the string
+you passed instead of `final` and returns `this` from update.