​

primitives/BloomFilter

​

Classes

​

InvalidBloomFilterLengthError

​

Example

throw new InvalidBloomFilterLengthError(
  'Expected 512 hex chars, got 256',
  {
    value: 256,
    expected: '512 hex chars',
    code: 'BLOOM_FILTER_INVALID_LENGTH',
    docsPath: '/primitives/bloom-filter/from-hex#error-handling'
  }
)

​

Extends

• InvalidLengthError

​

Constructors

Constructor

new InvalidBloomFilterLengthError(message, options?): InvalidBloomFilterLengthError

Parameters

message

options?

cause?

code?

context?

docsPath?

expected?

value?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidBloomFilterParameterError

​

Example

throw new InvalidBloomFilterParameterError(
  'Bloom filter parameters must be positive',
  {
    value: { m, k },
    expected: 'm > 0 and k > 0',
    code: 'BLOOM_FILTER_INVALID_PARAMETER',
    docsPath: '/primitives/bloom-filter/create#error-handling'
  }
)

​

Extends

• InvalidRangeError

​

Constructors

Constructor

new InvalidBloomFilterParameterError(message, options?): InvalidBloomFilterParameterError

Parameters

message

options?

cause?

code?

context?

docsPath?

expected?

value?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

Type Aliases

​

BloomFilterType

BloomFilterType = Uint8Array & object

​

Type Declaration

[brand]

readonly [brand]: "BloomFilter"

k

readonly k: number

m

readonly m: number

toHex()

toHex(this): string

Parameters

this

Returns

​

Variables

​

BITS

const BITS: 2048 = 2048

​

DEFAULT_HASH_COUNT

const DEFAULT_HASH_COUNT: 3 = 3

​

SIZE

const SIZE: 256 = 256

​

Functions

​

add()

add(filter, item): void

​

Parameters

filter

item

​

Returns

​

BloomFilter()

BloomFilter(m, k): BloomFilterType

​

Parameters

m

k

​

Returns

​

combine()

combine(…filters): BloomFilterType

​

Parameters

filters

​

Returns

​

contains()

contains(filter, item): boolean

​

Parameters

filter

item

​

Returns

​

create()

create(m, k): BloomFilterType

​

Parameters

m

k

​

Returns

​

density()

density(filter): number

​

Parameters

filter

​

Returns

​

expectedFalsePositiveRate()

expectedFalsePositiveRate(filter, itemCount): number

​

Parameters

filter

itemCount

​

Returns

​

fromHex()

fromHex(hex, m, k): BloomFilterType

​

Parameters

hex

m

k

​

Returns

​

hash()

hash(item, seed, m): number

​

Parameters

item

seed

m

​

Returns

​

isEmpty()

isEmpty(filter): boolean

​

Parameters

filter

​

Returns

​

merge()

merge(filter1, filter2): BloomFilterType

​

Parameters

filter1

filter2

​

Returns

​

toHex()

toHex(filter): string

​

Parameters

filter

​

Returns