Menu
×
   ❮     
HTML CSS JAVASCRIPT SQL PYTHON JAVA PHP HOW TO W3.CSS C C++ C# BOOTSTRAP REACT MYSQL JQUERY EXCEL XML DJANGO NUMPY PANDAS NODEJS R TYPESCRIPT ANGULAR GIT POSTGRESQL MONGODB ASP AI GO KOTLIN SASS VUE DSA GEN AI SCIPY AWS CYBERSECURITY DATA SCIENCE
     ❯   

Node.js Buffer.compare() Method

❮ Buffer Module


Example

Check if two buffer objects are equal:

var buf1 = Buffer.from('abc');
var buf2 = Buffer.from('abc');
var x = Buffer.compare(buf1, buf2);
console.log(x);

var buf1 = Buffer.from('a');
var buf2 = Buffer.from('b');
var x = Buffer.compare(buf1, buf2);
console.log(x);

var buf1 = Buffer.from('b');
var buf2 = Buffer.from('a');
var x = Buffer.compare(buf1, buf2);
console.log(x);
Run example »

Definition and Usage

The compare() method compares two buffer objects and returns a number defining their differences:

0 if they are equal
1 if buf1 is higher than buf2
-1 if buf1 is lower than buf2

This method can be used to sort arrays containing buffers.


Syntax

 Buffer.compare(buf1, buf2);

Parameter Values

Parameter Description
buf1 Required. A Buffer
buf2 Required. A Buffer

Technical Details

Return Value: A number (-1, 0, or 1)
Node.js Version: 0.11.13

More Examples

Example

Use Buffer.compare() to sort an array of buffers:

var buf1 = Buffer.from('b');
var buf2 = Buffer.from('c');
var buf3 = Buffer.from('a');
var arr = [buf1, buf2, buf3];

//The array before sorting:
console.log(arr);

//Sort the array:
console.log(arr.sort(Buffer.compare));
Run example »

❮ Buffer Module

×

Contact Sales

If you want to use W3Schools services as an educational institution, team or enterprise, send us an e-mail:
sales@w3schools.com

Report Error

If you want to report an error, or if you want to make a suggestion, send us an e-mail:
help@w3schools.com

W3Schools is optimized for learning and training. Examples might be simplified to improve reading and learning. Tutorials, references, and examples are constantly reviewed to avoid errors, but we cannot warrant full correctness of all content. While using W3Schools, you agree to have read and accepted our terms of use, cookie and privacy policy.

Copyright 1999-2024 by Refsnes Data. All Rights Reserved. W3Schools is Powered by W3.CSS.