Buffer is a temporary memory storage which stores the data when it is being moved from one place to another. It is like an array of integers. Buffer.compare() method compares the two given buffers.
buffer1.compare( targetBuffer, targetStart, targetEnd, sourceStart, sourceEnd )
Parameters: This method accepts five parameters as mentioned above and described below:
- targetBuffer: This parameter holds the buffer which will be compared with other buffer.
- targetStart: It refers to the starting index from which the elements of target buffer will begin comparing. Its default value is 0.
- targetEnd: It refers to the index till which the elements of target buffer will be compared. The default value is 0.
- sourceStart: The index in input buffer from which the comparing of values will start. The default value is 0.
- sourceEnd: The index in input buffer till which the comparing of values will be done. The default value is buffer.length
Return Value: It returns a number indicating the difference in both buffers. The returns number are:
- 0: If they are equal.
- 1: If buffer1 is higher than buffer2 i.e. if buffer1 should come before buffer2 when sorted.
- -1: If buffer2 is higher than buffer1 i.e. if buffer2 should come before buffer1 when sorted.
Below examples illustrate the Buffer.compare() Method in Node.js:
[ <Buffer 32>, <Buffer 31>, <Buffer 33> ] [ <Buffer 31>, <Buffer 32>, <Buffer 33> ]
Note: The above program will compile and run by using the
node index.js command.