https://github.com/redis/hiredis-node

Node wrapper for hiredis
https://github.com/redis/hiredis-node

Last synced: about 1 month ago
JSON representation

Node wrapper for hiredis

• Host: GitHub
• URL: https://github.com/redis/hiredis-node
• Owner: redis
• License: bsd-3-clause
• Archived: true
• Created: 2010-11-23T10:10:57.000Z (almost 14 years ago)
• Default Branch: master
• Last Pushed: 2019-11-21T14:28:53.000Z (almost 5 years ago)
• Last Synced: 2024-05-02T05:04:47.684Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 109 KB
• Stars: 304
• Watchers: 23
• Forks: 84
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING

Awesome Lists containing this project

README

        
# [Use node-redis](https://github.com/NodeRedis/node_redis)

`hiredis-node` is deprecated, unmaintained and not updated in forever. [Use node-redis](https://github.com/NodeRedis/node_redis).

---

[![Build Status](https://travis-ci.org/redis/hiredis-node.png?branch=master)](https://travis-ci.org/redis/hiredis-node)

# hiredis-node

Node extension that wraps [hiredis][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.

[hiredis]: http://github.com/redis/hiredis

## Install

Install with [NPM][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](.travis.yml).

[npm]: https://npmjs.org/

## 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][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:

```javascript

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:

```javascript

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() // => 

```

[node_redis]: http://github.com/mranney/node_redis

## 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][windows_fork] by Dmitry Gorbunos (@fuwaneko), which should now be unnecessary.

[windows_fork]: https://github.com/fuwaneko/hiredis-node

## License

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