redis-parser
Advanced tools
Package description
The redis-parser npm package is designed for parsing responses from a Redis server. It supports both JavaScript and TypeScript and is capable of handling different types of Redis responses, including errors, simple strings, integers, bulk strings, arrays, and more. It's particularly useful for developers working with Redis in Node.js environments, providing a straightforward way to interpret the data returned by Redis commands.
Error Handling
This feature allows handling of Redis errors. When a Redis server responds with an error, the parser can catch and process this error appropriately.
{"const { Parser } = require('redis-parser');
const parser = new Parser({
returnError: function(err) { console.error('Error:', err); },
returnReply: function(reply) { console.log('Reply:', reply); }
});
parser.execute(Buffer.from('-Error message\r\n'));
}Parsing Simple Strings
This demonstrates how to parse simple string responses from Redis. It's useful for commands that return a simple status response.
{"const { Parser } = require('redis-parser');
const parser = new Parser({
returnError: function(err) { console.error('Error:', err); },
returnReply: function(reply) { console.log('Reply:', reply); }
});
parser.execute(Buffer.from('+OK\r\n'));
}Parsing Arrays
This feature is for parsing array responses from Redis, which is common for commands that return multiple values.
{"const { Parser } = require('redis-parser');
const parser = new Parser({
returnError: function(err) { console.error('Error:', err); },
returnReply: function(reply) { console.log('Reply:', reply); }
});
parser.execute(Buffer.from('*2\r\n$3\r\nfoo\r\n$3\r\nbar\r\n'));
}ioredis is a robust, performance-focused, and full-featured Redis client for Node.js. Unlike redis-parser, which focuses solely on parsing responses, ioredis provides a comprehensive solution for interacting with Redis, including connection, command execution, and response parsing.
node_redis is another popular Redis client for Node.js. It offers a callback-based API for executing Redis commands and handling responses. While node_redis includes its own response parsing mechanisms, redis-parser is a standalone parser that could be used to augment or replace the default parsing in custom implementations.
Changelog
v.2.0.4 - 21 Jul, 2016
Bugfixes
Readme
A high performance javascript redis parser built for node_redis and ioredis. Parses all RESP data.
Install with NPM:
npm install redis-parser
var Parser = require('redis-parser');
var myParser = new Parser(options);
returnReply: function; mandatoryreturnError: function; mandatoryreturnFatalError: function; optional, defaults to the returnError functionreturnBuffers: boolean; optional, defaults to falsevar Parser = require("redis-parser");
function Library () {}
Library.prototype.returnReply = function (reply) { ... }
Library.prototype.returnError = function (err) { ... }
Library.prototype.returnFatalError = function (err) { ... }
var lib = new Library();
var parser = new Parser({
returnReply: function(reply) {
lib.returnReply(reply);
},
returnError: function(err) {
lib.returnError(err);
},
returnFatalError: function (err) {
lib.returnFatalError(err);
}
});
Library.prototype.streamHandler = function () {
this.stream.on('data', function (buffer) {
// Here the data (e.g. `new Buffer('$5\r\nHello\r\n'`)) is passed to the parser and the result is passed to either function depending on the provided data.
parser.execute(buffer);
});
};
You do not have to use the returnFatalError function. Fatal errors will be returned in the normal error function in that case.
And if you want to return buffers instead of strings, you can do this by adding the returnBuffers option.
Big numbers that are too large for JS are automatically stringified.
// Same functions as in the first example
var parser = new Parser({
returnReply: function(reply) {
lib.returnReply(reply);
},
returnError: function(err) {
lib.returnError(err);
},
returnBuffers: true // All strings are returned as buffer e.g. <Buffer 48 65 6c 6c 6f>
});
// The streamHandler as above
To handle protocol errors (this is very unlikely to happen) gracefully you should add the returnFatalError option, reject any still running command (they might have been processed properly but the reply is just wrong), destroy the socket and reconnect. Note that while doing this no new command may be added, so all new commands have to be buffered in the meantime, otherwise a chunk might still contain partial data of a following command that was already processed properly but answered in the same chunk as the command that resulted in the protocol error.
The parser is highly optimized but there may still be further optimizations possible.
npm install
npm test
npm run benchmark
FAQs
Javascript Redis protocol (RESP) parser
The npm package redis-parser receives a total of 4,425,047 weekly downloads. As such, redis-parser popularity was classified as popular.
We found that redis-parser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.