buffer-indexof-polyfill

What is buffer-indexof-polyfill?

The buffer-indexof-polyfill npm package provides a polyfill for the `indexOf` method on Buffer instances in Node.js. This is particularly useful for environments or versions of Node.js where `Buffer.indexOf` is not available. It allows developers to search for sequences within buffer objects, similar to how strings are searched in JavaScript.

What are buffer-indexof-polyfill's main functionalities?

Finding the index of a string within a buffer

This feature allows you to find the first occurrence of a string within a buffer. The code sample demonstrates searching for the string 'world' within a buffer containing 'hello world', which returns the index 6, indicating the start of the match.

var indexOf = require('buffer-indexof-polyfill');
var buf = Buffer.from('hello world');
var index = indexOf(buf, 'world');
console.log(index); // Outputs: 6

Finding the index of a buffer within another buffer

This feature enables searching for a sequence of bytes (represented by a buffer) within another buffer. The example shows how to find a buffer containing 'world' within another buffer, yielding the same result as searching for a string.

var indexOf = require('buffer-indexof-polyfill');
var buf = Buffer.from('hello world');
var search = Buffer.from('world');
var index = indexOf(buf, search);
console.log(index); // Outputs: 6

Other packages similar to buffer-indexof-polyfill

buffer-indexof

Similar to buffer-indexof-polyfill, buffer-indexof provides functionality to find the index of a buffer within another buffer. The main difference is that buffer-indexof is not specifically a polyfill and may offer optimized performance for certain use cases.

safe-buffer

While not directly offering the same functionality, safe-buffer provides a safer way to work with buffers in Node.js, including a consistent API across different Node.js versions. It can be used alongside methods like `indexOf` to ensure compatibility and safety.

README

buffer-indexof-polyfill

This is a polyfill for Buffer#indexOf and Buffer#lastIndexOf introduced in NodeJS 4.0.

Example

require("buffer-indexof-polyfill");

new Buffer("buffer").indexOf("uff") // return 1
new Buffer("buffer").indexOf("abc") // return -1

Installation

npm install buffer-indexof-polyfill

License

MIT