Skip to main content
Module

std/node/buffer.ts>Buffer#includes

Deno standard library
denoland/deno_std
Go to Latest
method Buffer.prototype.includes
import { Buffer } from "https://deno.land/std@0.177.0/node/buffer.ts";

Equivalent to buf.indexOf() !== -1.

import { Buffer } from '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

value: string | number | Buffer

What to search for.

optional
byteOffset: number

Where to begin searching in buf. If negative, then offset is calculated from the end of buf.

optional
encoding: Encoding

If value is a string, this is its encoding.

Returns

boolean

true if value was found in buf, false otherwise.