Skip to content

Commit 365b0d0

Browse files
committed
fixed incorrect ioredis link
1 parent a24e8c3 commit 365b0d0

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# redis-parser
66

7-
A high performance redis parser solution built for [node_redis](https://github.com/NodeRedis/node_redis) and [ioredis](https://github.com/ioredis/luin).
7+
A high performance redis parser solution built for [node_redis](https://github.com/NodeRedis/node_redis) and [ioredis](https://github.com/luin/ioredis).
88

99
Generally all [RESP](http://redis.io/topics/protocol) data will be properly parsed by the parser.
1010

@@ -95,31 +95,22 @@ var parser = new Parser({
9595
The [hiredis](https://github.com/redis/hiredis) parser is still the fasted parser for
9696
Node.js and therefor used as default in redis-parser if the hiredis parser is available.
9797

98-
Otherwise the pure js NodeRedis parser is choosen that is almost as fast as the
98+
Otherwise the pure js NodeRedis parser is chosen that is almost as fast as the
9999
hiredis parser besides some situations in which it'll be a bit slower.
100100

101101
## Protocol errors
102102

103-
To handle protocol errors (this is very unlikely to happen) gracefuly 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.
103+
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.
104104
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.
105105

106106
## Contribute
107107

108108
The js parser is already optimized but there are likely further optimizations possible.
109-
Besides running the tests you'll also have to run the change at least against the node_redis benchmark suite and post the improvement in the PR.
110-
If you want to write a own parser benchmark, that would also be great!
111109

112110
```
113111
npm install
114112
npm test
115-
116-
# Run node_redis benchmark (let's guess you cloned node_redis in another folder)
117-
cd ../redis
118-
npm install
119-
npm run benchmark parser=javascript > old.log
120-
# Replace the changed parser in the node_modules
121-
npm run benchmark parser=javascript > new.log
122-
node benchmarks/diff_multi_bench_output.js old.log new.log > improvement.log
113+
npm run benchmark
123114
```
124115

125116
## License

0 commit comments

Comments
 (0)