method Buffer.includes
Jump to headingBuffer.includes(): boolean
Equivalent to buf.indexOf() !== -1
.
import { Buffer } from 'node:buffer';
const buf = Buffer.from('this is a buffer');
console.log(buf.includes('this'));
// Prints: true
console.log(buf.includes('is'));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer')));
// Prints: true
console.log(buf.includes(97));
// Prints: true (97 is the decimal ASCII value for 'a')
console.log(buf.includes(Buffer.from('a buffer example')));
// Prints: false
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: true
console.log(buf.includes('this', 4));
// Prints: false
Parameters Jump to heading
Jump to headingvalue:
What to search for.
optional
Jump to headingbyteOffset: number = 0
Where to begin searching in buf
. If negative, then offset is calculated from the end of buf
.
optional
Jump to headingencoding: BufferEncoding = 'utf8'
If value
is a string, this is its encoding.
Return Type Jump to heading
boolean
true
if value
was found in buf
, false
otherwise.