@albert-team/rebloom

REBLOOM

Minimalistic RedisBloom client for Node.js.

Installation

Requirements

• Node.js >= 10
• Redis >= 4
• RedisBloom >= 2.2.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', {
    host: 'localhost',
    port: 6379,
    redisClientOptions: { password: 'scrtpassword' },
  })
  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().catch((err) => console.error(err))

API

Read more here.

Changelog

Read more here.