node-redis-streamify

A Node.js library to augment node_redis interface with streaming version of commands SCAN, HSCAN, SSCAN, ZSCAN.

Installation

``
npm install node-redis-streamify --save
`

Usage

`javascript
var
redis = require('redis');

require('node-redis-streamify')(redis);

var
scan = redis.streamified('SCAN'); // case insensitive

scan('*')
.on('data', function (data) {
// your code here
// call this.end() if you want to stop scanning
})
.on('error', function (error) {
// your code here
})
.on('end', function () {
// your code here
});
`

Supported commands

* SCAN
* HSCAN
* SSCAN
* ZSCAN

Streamified API

$3

`javascript
var
pattern = '*',
count = 10,
scan = redis.streamified('SCAN'); // case insensitive

scan(pattern, count)
.on('data', function (data) {})
.on('error', function (error) {})
.on('end', function () {});
`

$3

`javascript
var
key = 'path:to:key'
pattern = '*',
count = 10,
hscan = redis.streamified('HSCAN'); // case insensitive

hscan(key, pattern, count)
.on('data', function (data) {})
.on('error', function (error) {})
.on('end', function () {});
`

$3

`javascript
var
key = 'path:to:key'
pattern = '*',
count = 10,
sscan = redis.streamified('SSCAN'); // case insensitive

sscan(key, pattern, count)
.on('data', function (data) {})
.on('error', function (error) {})
.on('end', function () {});
`

$3

`javascript
var
key = 'path:to:key'
pattern = '*',
count = 10,
zscan = redis.streamified('ZSCAN'); // case insensitive

zscan(key, pattern, count)
.on('data', function (data) {})
.on('error', function (error) {})
.on('end', function () {});
``

Alternatives

These are a few alternative projects:

* redis-scanstreams