hiredis

hiredis-node

Node extension that wraps hiredis. Because Node is already good at doing I/O, hiredis-node only provides bindings to the protocol parser. The hiredis protocol parser is faster than JavaScript protocol parsers, but the speedup only becomes noticeable for large replies. If you use Redis for simple SET/GET operations, there won't be a big benefit to using hiredis. If you use Redis for big SUNION/SINTER/LRANGE/ZRANGE operations, the benefit to using hiredis-node can be significant.

Install

Install with NPM:

npm install hiredis

This requires:

• gcc / g++ 4.8 or newer.
• python 2.7 or any newer 2.x version. python 3.x is not supported.

For running on Travis check the bundled .travis.yml.

Contribute

To work on the code, first fetch the bundled hiredis submodule, then build hiredis and run the tests.

git submodule update --init
npm install
npm test

Usage

hiredis-node works out of the box with Matt Ranney's node_redis. The latter has an optional dependency on hiredis-node, so maybe you're already using it without knowing.

Alternatively, you can use it directly:

var hiredis = require("hiredis"),
    reader = new hiredis.Reader();

// Data comes in
reader.feed("$5\r\nhello\r\n");

// Reply comes out
reader.get() // => "hello"

Instead of returning strings for bulk payloads, it can also return buffers:

var hiredis = require("hiredis"),
    reader = new hiredis.Reader({ return_buffers: true });

// Data comes in
reader.feed("$5\r\nhello\r\n");

// Reply comes out
reader.get() // => <Buffer 68 65 6c 6c 6f>

Windows

Since Version 0.3.0 hiredis-node officially supports Windows. A simple npm install hiredis should just work. If not, please open a bug report.

There's also a Windows fork by Dmitry Gorbunos (@fuwaneko), which should now be unnecessary.

License

This code is released under the BSD license, after the license of hiredis.

Changelog

0.5.0 (2016-04-xy)

• Dropping support for EOL Node versions.
  • This does not mean it breaks right now, but we're not testing against v0.8 and iojs anymore.
• Do not cast a potentially non-String value to String (#117, iamstolis)
• Upgrade to new nan version (#119, nicolashenry), avoiding deprecation warnings in Node v6