@types/bloom-filter v0.2.4

Installation

npm install --save @types/bloom-filter

Summary

This package contains type definitions for bloom-filter (https://github.com/bitpay/bloom-filter).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/bloom-filter.

index.d.ts

// Type definitions for bloom-filter 0.2
// Project: https://github.com/bitpay/bloom-filter
// Definitions by: Daniel Byrne <https://github.com/danwbyrne>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />

declare class Filter {
  constructor(options: Filter.FilterOptions);
  static create(elements: number, falsePositiveRate: number, nTweak?: number, nFlags?: number): Filter;
  toObject(): Filter.FilterOptions;
  hash(nHashNum: number, vDataToHash: Buffer): number;
  insert(data: Buffer): void;
  contains(data: Buffer): boolean;
  clear(): void;
  inspect(): string;
  BLOOM_UPDATE_NONE: number;
  BLOOM_UPDATE_ALL: number;
  BLOOM_UPDATE_P2PUBKEY_ONLY: number;
  MAX_BLOOM_FILTER_SIZE: number;
  MAX_HASH_FUNCS: number;
  MIN_HASH_FUNCS: number;
  LN2SQUARED: number;
  LN2: number;
}

declare namespace Filter {
  interface FilterOptions {
    vData: Buffer;
    nHashFuncs: number;
    nTweak?: number | undefined;
    nFlags?: number | undefined;
  }

  function MurmurHash3(seed: number, data: Buffer): number;
}

export = Filter;

Additional Details

• Last updated: Wed, 07 Jul 2021 21:45:00 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Daniel Byrne.