summaryrefslogtreecommitdiff
path: root/node_modules/buffer-equal/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/buffer-equal/README.markdown')
-rw-r--r--node_modules/buffer-equal/README.markdown62
1 files changed, 62 insertions, 0 deletions
diff --git a/node_modules/buffer-equal/README.markdown b/node_modules/buffer-equal/README.markdown
new file mode 100644
index 0000000..8c062fd
--- /dev/null
+++ b/node_modules/buffer-equal/README.markdown
@@ -0,0 +1,62 @@
+buffer-equal
+============
+
+Return whether two buffers are equal.
+
+[![build status](https://secure.travis-ci.org/substack/node-buffer-equal.png)](http://travis-ci.org/substack/node-buffer-equal)
+
+example
+=======
+
+``` js
+var bufferEqual = require('buffer-equal');
+
+console.dir(bufferEqual(
+ new Buffer([253,254,255]),
+ new Buffer([253,254,255])
+));
+console.dir(bufferEqual(
+ new Buffer('abc'),
+ new Buffer('abcd')
+));
+console.dir(bufferEqual(
+ new Buffer('abc'),
+ 'abc'
+));
+```
+
+output:
+
+```
+true
+false
+undefined
+```
+
+methods
+=======
+
+``` js
+var bufferEqual = require('buffer-equal')
+```
+
+bufferEqual(a, b)
+-----------------
+
+Return whether the two buffers `a` and `b` are equal.
+
+If `a` or `b` is not a buffer, return `undefined`.
+
+install
+=======
+
+With [npm](http://npmjs.org) do:
+
+```
+npm install buffer-equal
+```
+
+license
+=======
+
+MIT