blossom/bloom~ SafeBloomFilter

new SafeBloomFilter(capacityopt, errorRateopt, bufferopt)

Bloom filter enforcing a given false positive error probabilty for a given capacity.

Parameters:
NameTypeAttributesDefaultDescription
capacitynumber<optional>
20

Max number of items allowed

errorRatenumber<optional>
0.1

Max false positive error probabilty

bufferBuffer<optional>

Underlying buffer to use

Methods

add(key) → {boolean}

Adds item the the Bloom filter only if it is under capacity.

Parameters:
NameTypeDescription
keystring | Buffer

Item to add

Returns:

wasAdded

Type: 
boolean

has(key) → {boolean}

Checks if the given item probably exists in the Bloom filter.

Parameters:
NameTypeDescription
keystring | Buffer

Item to check

Returns:
Type: 
boolean

(static) destringify(data) → {SafeBloomFilter}

Create a SafeBloomFilter from an object

Parameters:
NameTypeDescription
dataobject
Properties
NameTypeDescription
capacitynumber

Max items to allow in filter

errorRatenumber

Max false positive rate allowed

countnumber

Number of items in filter

bitfieldobject
Properties
NameTypeDescription
bufferstring | array | object | Buffer

Underlying buffer

Returns:
Type: 
SafeBloomFilter