/rebloom

Minimalistic RedisBloom client for Node.js

Primary LanguageTypeScriptMIT LicenseMIT

REBLOOM

Minimalistic RedisBloom client for Node.js

Installation

Requirements

  • Node.js >= 8.0.0
  • Redis >= 4.0
  • RedisBloom >= 2.0.0

Instructions

With npm

npm i @albert-team/rebloom

With yarn

yarn add @albert-team/rebloom

Usage

Important:

  • Rebloom v2 is nearly a rewrite from scratch, thus not backward-compatible with Rebloom v1.
  • RedisBloom module needs to be loaded into Redis server beforehand.

Get Started

const { BloomFilter } = require('@albert-team/rebloom')

const main = async () => {
  const filter = new BloomFilter('filtername')
  await filter.connect()

  console.log(await filter.add('item0')) // 1
  console.log(await filter.exists('item0')) // 1
  console.log(await filter.exists('item1')) // 0

  await filter.disconnect()
}

main()

API

Changelog

Read more here.