aboutsummaryrefslogtreecommitdiff
path: root/node_modules/buf-compare/readme.md
blob: a34dfce537b44e76fb7c8272697a1447e7a77afe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# buf-compare [![Build Status](https://travis-ci.org/sindresorhus/buf-compare.svg?branch=master)](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)