Class CountingBloomFilter<T>

constructor

• new CountingBloomFilter<T extends { toString(): string }>(
      options: Options,
  ): CountingBloomFilter<T>

  Creates a counting filter from its size, hash count, and optional seed or counters.

  Type Parameters

  • T extends { toString(): string }

    Values represented by the filter.

  Parameters

  • options: Options

    Filter size, hash count, and optional initial state.

  Returns CountingBloomFilter<T>

  A new counting Bloom filter.

  Throws

  Error if size or hashes is not a positive integer, or if filter does not hold size counters.

Readonlyfilter

Readonlyhashes

Readonlyseed

Readonlysize

add

• add(element: T): void

  Adds an instance of an element and increments its counters.

  Parameters

  • element: T

    Value to add.

  Returns void

has

• has(element: T): number

  Returns the possible number of times an element was added.

  Parameters

  • element: T

    Value to look up.

  Returns number

  The minimum counter value for this element's hash positions.

remove

• remove(element: T): void

  Removes an instance of an element without allowing counters below zero.

  Parameters

  • element: T

    Value to remove.

  Returns void

toJSON

• toJSON(): SerialisedCountingBloomFilter

  Returns the filter state in a JSON-serialisable form.

  Returns SerialisedCountingBloomFilter

  Filter size, hash count, seed, and counter data.