streamsearch
Advanced tools
Weekly downloads
Readme
streamsearch is a module for node.js that allows searching a stream using the Boyer-Moore-Horspool algorithm.
This module is based heavily on the Streaming Boyer-Moore-Horspool C++ implementation by Hongli Lai here.
npm install streamsearch
const { inspect } = require('util');
const StreamSearch = require('streamsearch');
const needle = Buffer.from('\r\n');
const ss = new StreamSearch(needle, (isMatch, data, start, end) => {
if (data)
console.log('data: ' + inspect(data.toString('latin1', start, end)));
if (isMatch)
console.log('match!');
});
const chunks = [
'foo',
' bar',
'\r',
'\n',
'baz, hello\r',
'\n world.',
'\r\n Node.JS rules!!\r\n\r\n',
];
for (const chunk of chunks)
ss.push(Buffer.from(chunk));
// output:
//
// data: 'foo'
// data: ' bar'
// match!
// data: 'baz, hello'
// match!
// data: ' world.'
// match!
// data: ' Node.JS rules!!'
// match!
// data: ''
// match!
maxMatches - < integer > - The maximum number of matches. Defaults to Infinity
.
matches - < integer > - The current match count.
(constructor)(< mixed >needle, < function >callback) - Creates and returns a new instance for searching for a Buffer or string needle
. callback
is called any time there is non-matching data and/or there is a needle match. callback
will be called with the following arguments:
isMatch
- boolean - Indicates whether a match has been found
data
- mixed - If set, this contains data that did not match the needle.
start
- integer - The index in data
where the non-matching data begins (inclusive).
end
- integer - The index in data
where the non-matching data ends (exclusive).
isSafeData
- boolean - Indicates if it is safe to store a reference to data
(e.g. as-is or via data.slice()
) or not, as in some cases data
may point to a Buffer whose contents change over time.
destroy() - (void) - Emits any last remaining unmatched data that may still be buffered and then resets internal state.
push(< Buffer >chunk) - integer - Processes chunk
, searching for a match. The return value is the last processed index in chunk
+ 1.
reset() - (void) - Resets internal state. Useful for when you wish to start searching a new/different stream for example.
Streaming Boyer-Moore-Horspool searching for node.js
The npm package streamsearch receives a total of 8,162,968 weekly downloads. As such, streamsearch popularity was classified as popular.
We found that streamsearch demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.