buffer.compare()

buf.compare(otherBuffer)

otherBuffer <Buffer>
Return: <Number>

Compares two Buffer instances and returns a number indicating whether buf comes before, after, or is the same as the otherBuffer in sort order. Comparison is based on the actual sequence of bytes in each Buffer.

0 is returned if otherBuffer is the same as buf
1 is returned if otherBuffer should come before buf when sorted.
-1 is returned if otherBuffer should come after buf when sorted.

const buf1 = Buffer.from('ABC');
const buf2 = Buffer.from('BCD');
const buf3 = Buffer.from('ABCD');
 
console.log(buf1.compare(buf1));
  // Prints: 0
console.log(buf1.compare(buf2));
  // Prints: -1
console.log(buf1.compare(buf3));
  // Prints: 1
console.log(buf2.compare(buf1));
  // Prints: 1
console.log(buf2.compare(buf3));
  // Prints: 1
 
[buf1, buf2, buf3].sort(Buffer.compare);
  // produces sort order [buf1, buf3, buf2]

Links:

https://nodejs.org/dist/latest-v5.x/docs/api/buffer.html#buffer_buf_compare_otherbuffer

doc_Nodejs

2025-01-10 15:47:30

Comments