bloom-stream v0.6.0

bloom-stream

Pipe in your stream of buffers/strings to get approximate set membership (using Bloom filter).

var Bloom = require('bloom-stream');
var es = require('event-stream');
var fs = require('fs');

var bloom = new Bloom(128, 3);
//or
var bloom = Bloom.forCapacity(1000000, 0.1);

fs.createReadStream('data.txt')
  .pipe(es.split())
  .pipe(bloom);

bloom.on('finish', function() {
  console.log('has 42', bloom.has('42'));
  console.log('has 13', bloom.has('13'));
});

API

Bloom(size, numHashes, seed, hashType, streamOpts)

Construct a new writable Bloom (extends Stream.Writable).

• size - number of bits in the bloom filter table (default 128).
• numHashes - number of bits to set for each element added (default 3).
• seed - seed integer to seed hash functions with (default 42).
• hashType - which hashing algorithm to use on the values. Can be 'murmur' or any algorithm supported by crypto.createHash (default: 'murmur').

• streamOpts - the options to pass along to the stream constructor.

Bloom.forCapacity(capacity, errorRate, seed, hashType, streamOpts)

Generate a new writable Bloom with size, and numHashes suitable for approximate cardinality capacity, and approximate error rate errorRate.

• capacity - approximate cardinality of input set
• errorRate - approximate acceptable false-positive rate (0-1) (default 0.1).
• seed - seed integer to seed hash functions with (default 42).
• hashType - which hashing algorithm to use on the values. Can be 'murmur' or any algorithm supported by crypto.createHash (default: 'murmur').
• streamOpts - the options to pass along to the stream constructor.

Bloom.has(element)

Test for membership of element.

Bloom.merge(bloom)

Merge another Bloom with this one. The two Blooms must have the same size, numHashes, seed, and hashType. Returns a new Bloom.

• bloom - another instance of bloom-stream to merge with this one.

Bloom.export()

Export the Bloom's data. Returns an object like:

{
  size: 128,
  numHashes: 3,
  seed: 42,
  hashType: 'murmur',
  registers: [...]
}

Bloom.import(data)

Import Bloom data (as exported by export()). Replaces any pre-existing data.

• data - the data object to import. Should be in the same format as exported by export().