Node.js Buffer buf.indexOf(value[, byteOffset][, encoding])用法及代码示例

buf.indexOf(value[, byteOffset][, encoding])

参数

• value <string> | <Buffer> | <Uint8Array> | <integer> 要搜索的内容。
• byteOffset <integer> 在 buf 中从哪里开始搜索。如果为负，则从 buf 的末尾计算偏移量。 默认： 0 。
• encoding <string> 如果 value 是字符串，则这是用于确定将在 buf 中搜索的字符串的二进制表示形式的编码。 默认： 'utf8' 。
• 返回： <integer> buf 中第一次出现 value 的索引，如果 buf 不包含 value ，则返回 -1。

如果value 是：

• 一个字符串 value 根据 encoding 中的字符编码进行解释。
• a Buffer 或 Uint8Array ， value 将全部使用。要比较部分 Buffer ，请使用 buf.subarray 。
• 一个数字 value 将被解释为 0 和 255 之间的无符号 8 位整数值。

import { Buffer } from 'node:buffer';

const buf = Buffer.from('this is a buffer');

console.log(buf.indexOf('this'));
// Prints: 0
console.log(buf.indexOf('is'));
// Prints: 2
console.log(buf.indexOf(Buffer.from('a buffer')));
// Prints: 8
console.log(buf.indexOf(97));
// Prints: 8 (97 is the decimal ASCII value for 'a')
console.log(buf.indexOf(Buffer.from('a buffer example')));
// Prints: -1
console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
// Prints: 8

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// Prints: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// Prints: 6const { Buffer } = require('node:buffer');

const buf = Buffer.from('this is a buffer');

console.log(buf.indexOf('this'));
// Prints: 0
console.log(buf.indexOf('is'));
// Prints: 2
console.log(buf.indexOf(Buffer.from('a buffer')));
// Prints: 8
console.log(buf.indexOf(97));
// Prints: 8 (97 is the decimal ASCII value for 'a')
console.log(buf.indexOf(Buffer.from('a buffer example')));
// Prints: -1
console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
// Prints: 8

const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
// Prints: 4
console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
// Prints: 6

如果 value 不是字符串、数字或 Buffer ，则此方法将抛出 TypeError 。如果value 是一个数字，它将被强制转换为一个有效的字节值，一个介于 0 和 255 之间的整数。

如果byteOffset 不是数字，它将被强制转换为数字。如果强制的结果是 NaN 或 0 ，则将搜索整个缓冲区。此行为与 String.prototype.indexOf() 匹配。

import { Buffer } from 'node:buffer';

const b = Buffer.from('abcdef');

// Passing a value that's a number, but not a valid byte.
// Prints: 2, equivalent to searching for 99 or 'c'.
console.log(b.indexOf(99.9));
console.log(b.indexOf(256 + 99));

// Passing a byteOffset that coerces to NaN or 0.
// Prints: 1, searching the whole buffer.
console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));const { Buffer } = require('node:buffer');

const b = Buffer.from('abcdef');

// Passing a value that's a number, but not a valid byte.
// Prints: 2, equivalent to searching for 99 or 'c'.
console.log(b.indexOf(99.9));
console.log(b.indexOf(256 + 99));

// Passing a byteOffset that coerces to NaN or 0.
// Prints: 1, searching the whole buffer.
console.log(b.indexOf('b', undefined));
console.log(b.indexOf('b', {}));
console.log(b.indexOf('b', null));
console.log(b.indexOf('b', []));

如果 value 为空字符串或空 Buffer 且 byteOffset 小于 buf.length ，则将返回 byteOffset。如果 value 为空且 byteOffset 至少为 buf.length ，则将返回 buf.length。