redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-25 00:40:59 +03:00
Code Activity

Merge pull request #1018 from NodeRedis/docu

Browse Source 
Improve test and add some more documentation
This commit is contained in:
Ruben Bridgewater
2016-03-26 01:03:07 +01:00
parent 6e063018f5 7af90043c8
commit 5294917280
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -215,7 +215,7 @@ limits total amount of connection tries. Setting this to 1 will prevent any reco
* `rename_commands`: *null*; pass a object with renamed commands to use those instead of the original functions. See the [redis security topics](http://redis.io/topics/security) for more info.
* `tls`: an object containing options to pass to [tls.connect](http://nodejs.org/api/tls.html#tls_tls_connect_port_host_options_callback),
to set up a TLS connection to Redis (if, for example, it is set up to be accessible via a tunnel).
* `prefix`: *null*; pass a string to prefix all used keys with that string as prefix e.g. 'namespace:test'
* `prefix`: *null*; pass a string to prefix all used keys with that string as prefix e.g. 'namespace:test'. Please be aware, that the "keys" command is not going to be prefixed. The command has a "pattern" as argument and no key and it would be impossible to determine the existing keys in Redis if this would be prefixed.
* `retry_strategy`: *function*; pass a function that receives a options object as parameter including the retry `attempt`, the `total_retry_time` indicating how much time passed since the last time connected, the `error` why the connection was lost and the number of `times_connected` in total. If you return a number from this function, the retry will happen exactly after that time in milliseconds. If you return a non-number no further retry is going to happen and all offline commands are flushed with errors. Return a error to return that specific error to all offline commands. Check out the example too.
```js

6
test/auth.spec.js
View File

@@ -52,8 +52,10 @@ describe("client authentication", function () {
var time = Date.now();
client.auth(auth, function (err, res) {
assert.strictEqual('retry worked', res);
assert(Date.now() - time >= 200, 'Time should be above 200 ms (the reconnect time)');
assert(Date.now() - time < 300, 'Time should be below 300 ms (the reconnect should only take a bit above 200 ms)');
var now = Date.now();
// Hint: setTimeout sometimes triggers early and therefor the value can be like one or two ms to early
assert(now - time >= 198, 'Time should be above 200 ms (the reconnect time) and is ' + (now - time));
assert(now - time < 300, 'Time should be below 300 ms (the reconnect should only take a bit above 200 ms) and is ' + (now - time));
done();
});
var tmp = client.command_queue.get(0).callback;