Package Exports

streamsearch

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (streamsearch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Description

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.

Requirements

node.js -- v0.8.0 or newer

Installation

npm install streamsearch

Example

  var StreamSearch = require('streamsearch'),
      inspect = require('util').inspect;

  var needle = new Buffer([13, 10]), // CRLF
      s = new StreamSearch(needle),
      chunks = [
        new Buffer('foo'),
        new Buffer(' bar'),
        new Buffer('\r'),
        new Buffer('\n'),
        new Buffer('baz, hello\r'),
        new Buffer('\n world.'),
        new Buffer('\r\n Node.JS rules!!\r\n\r\n')
      ];
  s.on('data', function(data, start, end) {
    console.log('data: ' + inspect(data.toString('ascii', start, end)));
  });
  s.on('match', function() {
    console.log('match!');
  });
  for (var i = 0, len = chunks.length; i < len; ++i)
    s.push(chunks[i]);

  // output:
  //
  // data: 'foo'
  // data: ' bar'
  // match!
  // data: 'baz, hello'
  // match!
  // data: ' world.'
  // match!
  // data: ' Node.JS rules!!'
  // match!
  // data: ''
  // match!

API

Events

data(< _Buffer_ >chunk, < _integer_ >start, < _integer_ >end) - Emitted when non-needle data is available. This data is in chunk between start (inclusive) and end (exclusive).
match() - Emitted when the needle has been found in the stream.

Properties

maxMatches - < _integer_ > - The maximum number of matches. This is especially useful when multiple matches exist within a single chunk passed to push(), so that this module knows to stop matching within that single chunk. Defaults to Infinity.
matches - < _integer_ > - The current match count.

Functions

(constructor)(< _Buffer_ >needle) - Creates and returns a new instance for searching for needle.
push(< _Buffer_ >chunk) - integer - Process chunk. 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.