A probabilistic data structure that tracks memberships in a set. Supports time and space efficient lookups, but may return false-positives. Can never return false-negatives. A bloom filter can tell us if an element is:

  • Definitely not in the set
  • Potentially in the set (with a probability depending on the false-positive rate)

Constructors

  • Parameters

    • options: BloomFilterOptions
    • hashN: ((item, n, maxValue) => number)
        • (item, n, maxValue): number
        • Parameters

          • item: string
          • n: number
          • maxValue: number

          Returns number

    Returns BloomFilter

Properties

data: bigint[] = []
errorRate: number
hashN: ((item, n, maxValue) => number)

Type declaration

    • (item, n, maxValue): number
    • Parameters

      • item: string
      • n: number
      • maxValue: number

      Returns number

kHashes: number
options: BloomFilterOptions
totalBits: number

Methods

  • Parameters

    • item: string

    Returns number[]

  • Parameters

    • item: string

    Returns void

  • Parameters

    • item: string

    Returns boolean

  • Returns Uint8Array

  • Parameters

    • bytes: Uint8Array
    • options: BloomFilterOptions
    • hashN: ((item, n, maxValue) => number)
        • (item, n, maxValue): number
        • Parameters

          • item: string
          • n: number
          • maxValue: number

          Returns number

    Returns BloomFilter