Socket
Socket
Sign inDemoInstall

node-redis-streamify

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    node-redis-streamify

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


Version published
Weekly downloads
633
decreased by-11.34%
Maintainers
1
Install size
82.0 kB
Created
Weekly downloads
 

Readme

Source

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

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

Streamified API

SCAN

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

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

HSCAN

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 () {});

SSCAN

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 () {});

ZSCAN

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:

Keywords

FAQs

Last updated on 06 Jun 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc