Node.js Buffer buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])用法及代碼示例

buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])

參數

• target <Buffer> | <Uint8Array> A Buffer 或 Uint8Array 與之比較 buf 。
• targetStart <integer> target 內開始比較的偏移量。 默認： 0 。
• targetEnd <integer> target 中結束比較的偏移量(不包括在內)。 默認： target.length 。
• sourceStart <integer> buf 內開始比較的偏移量。 默認： 0 。
• sourceEnd <integer> buf 中結束比較的偏移量(不包括在內)。 默認： buf.length 。
• 返回： <integer>

比較 buf 和 target 並返回一個數字，指示 buf 在排序順序中是在 target 之前、之後還是與 target 相同。比較基於每個 Buffer 中的實際字節序列。

• 如果 target 與 buf 相同，則返回 0
• 1如果返回target應該來前 buf排序時。
• -1如果返回target應該來後 buf排序時。

import { Buffer } from 'node:buffer';

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
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// Prints: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
// (This result is equal to: [buf1, buf3, buf2].)const { Buffer } = require('node:buffer');

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
console.log([buf1, buf2, buf3].sort(Buffer.compare));
// Prints: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
// (This result is equal to: [buf1, buf3, buf2].)

可選的 targetStart 、 targetEnd 、 sourceStart 和 sourceEnd 參數可用於分別將比較限製在 target 和 buf 內的特定範圍內。

import { Buffer } from 'node:buffer';

const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

console.log(buf1.compare(buf2, 5, 9, 0, 4));
// Prints: 0
console.log(buf1.compare(buf2, 0, 6, 4));
// Prints: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// Prints: 1const { Buffer } = require('node:buffer');

const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

console.log(buf1.compare(buf2, 5, 9, 0, 4));
// Prints: 0
console.log(buf1.compare(buf2, 0, 6, 4));
// Prints: -1
console.log(buf1.compare(buf2, 5, 6, 5));
// Prints: 1

如果 targetStart < 0 、 sourceStart < 0 、 targetEnd > target.byteLength 或 sourceEnd > source.byteLength ，則拋出 ERR_OUT_OF_RANGE 。