diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-03 15:35:00 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-03 15:35:00 +0200 |
commit | de98e0b232509d5f40c135d540a70e415272ff85 (patch) | |
tree | a79222a5b58484ab3b80d18efcaaa7ccc4769b33 /node_modules/buffer-xor/README.md | |
parent | e0c9d480a73fa629c1e4a47d3e721f1d2d345406 (diff) |
node_modules
Diffstat (limited to 'node_modules/buffer-xor/README.md')
-rw-r--r-- | node_modules/buffer-xor/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/buffer-xor/README.md b/node_modules/buffer-xor/README.md new file mode 100644 index 000000000..007f05828 --- /dev/null +++ b/node_modules/buffer-xor/README.md @@ -0,0 +1,41 @@ +# buffer-xor + +[](http://travis-ci.org/crypto-browserify/buffer-xor) +[](https://www.npmjs.org/package/buffer-xor) + +[](https://github.com/feross/standard) + +A simple module for bitwise-xor on buffers. + + +## Examples + +``` javascript +var xor = require("buffer-xor") +var a = new Buffer('00ff0f', 'hex') +var b = new Buffer('f0f0', 'hex') + +console.log(xor(a, b)) +// => <Buffer f0 0f> +``` + + +Or for those seeking those few extra cycles, perform the operation in place: + +``` javascript +var xorInplace = require("buffer-xor/inplace") +var a = new Buffer('00ff0f', 'hex') +var b = new Buffer('f0f0', 'hex') + +console.log(xorInplace(a, b)) +// => <Buffer f0 0f> +// NOTE: xorInplace will return the shorter slice of its parameters + +// See that a has been mutated +console.log(a) +// => <Buffer f0 0f 0f> +``` + + +## License [MIT](LICENSE) + |