Interface BloomFilterOptions<T>

Options for creating a BloomFilter.

interface BloomFilterOptions {
    hash?: ((value, seed) => number);
    k: number;
    m: number;
    n?: number;
    value?: string | number | bigint;
}

Type Parameters

  • T

Properties

hash? k m n? value?

Properties

Optional Readonly hash

hash?: ((value, seed) => number)

Type declaration

    • (value, seed): number

    • The k hash functions

      Parameters

      • value: T
      • seed: number

      Returns number

Readonly k

k: number

The number of hash functions to use.

Readonly m

m: number

The bit size of the bloom filter.

Optional Readonly n

n?: number

The initial number of elements in the bloom filter.

Optional Readonly value

value?: string | number | bigint

The initial bit value of the bloom filter.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc