README.md

upring-set

Redis set api on top of Upring

Install

npm i upring-set --save

Usage

This library exposes the standard upring plugin interface.
Once you register it, it adds a set name space with the API documented below.
This plugin needs that upring-kv is registered as well.

const upring = require('upring')({
  logLevel: 'info',
  base: [],
  hashring: {
    joinTimeout: 200,
    replicaPoints: 10
  }
})

upring.use(require('upring-kv'))
upring.use(require('upring-set'))

upring.on('up', onReady)

async function onReady () {
  await upring.set.sadd('set', ['one', 'two', 'three'])
  const members = await upring.set.smembers('set')
  console.log(members) // ['one', 'two', 'three']
}

API

The API is not yet completed, if you need an API that is not implemented please fire a pull request!

sadd

Redis docs

await upring.set.sadd('set', ['one', 'two', 'three'])
await upring.set.sadd('key', 'value')

zadd

Redis docs

await upring.set.zadd('key', 1, 'value')

srem

Redis docs

await upring.set.srem('key', 'value')
await upring.set.srem('set', ['one', 'two', 'three'])

zrem

Redis docs

await upring.set.zrem('key', 'value')
await upring.set.zrem('set', ['one', 'two', 'three'])

del

Redis docs

await upring.set.del('key')

sinter

Redis docs

await upring.set.sinter(['set1', 'set2', 'set3'])

sunion

Redis docs

await upring.set.sunion(['set1', 'set2', 'set3'])

scard

Redis docs

await upring.set.scard('set')

zcard

Redis docs

await upring.set.zcard('set')

smembers

Redis docs

await upring.set.smembers('set')

sismembers

Redis docs

await upring.set.sismembers('set', 'value')

sunionstore

Redis docs

await upring.set.sunionstore('set', ['set1', 'set2', 'set3'])

sdiff

Redis docs

await upring.set.sdiff(['set1', 'set2', 'set3'])

zrange

Redis docs

await upring.set.zrange('set', 0, -1)

zrevrange

Redis docs

await upring.set.zrevrange('set', 0, -1)

zscore

Redis docs

await upring.set.zscore('set', 'value')

zincrby

Redis docs

await upring.set.zincrby('set', 1, 'value')

Acknowledgements

This project is kindly sponsored by LetzDoIt.

License

Licensed under MIT.