diff options
Diffstat (limited to 'node_modules/buf-compare/readme.md')
| -rw-r--r-- | node_modules/buf-compare/readme.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/node_modules/buf-compare/readme.md b/node_modules/buf-compare/readme.md new file mode 100644 index 000000000..a34dfce53 --- /dev/null +++ b/node_modules/buf-compare/readme.md @@ -0,0 +1,39 @@ +# buf-compare [](https://travis-ci.org/sindresorhus/buf-compare) + +> Node.js [`Buffer.compare()`](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_compare_buf1_buf2) [ponyfill](https://ponyfill.com) + + +## Install + +``` +$ npm install --save buf-compare +``` + + +## Usage + +```js +var bufCompare = require('buf-compare'); + +bufCompare(new Buffer('a'), new Buffer('a')); +//=> 0 + +bufCompare(new Buffer('a'), new Buffer('b')); +//=> -1 +``` + + +## API + +See the [`Buffer.compare()` docs](https://nodejs.org/api/buffer.html#buffer_class_method_buffer_compare_buf1_buf2). + + +## Related + +- [buffer-equals](https://github.com/sindresorhus/buffer-equals) - Node.js `buffer.equals()` ponyfill +- [buf-indexof](https://github.com/sindresorhus/buf-indexof) - Node.js `buffer.indexOf()` ponyfill + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |