diff --git a/README.md b/README.md index 2323fcf021..712a1e4bd3 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,8 @@ When the commands are all submitted, `EXEC` is called and the callbacks are invo If a command is submitted that doesn't pass the syntax check, it will be removed from the transaction. -I guess we also need a callback when `MULTI` finishes, in case the last command gets removed from an error. +`MULTI` needs some love. This way works, but it's too ugly and not progressive. Patches and +suggestions are welcome. # API @@ -134,31 +135,6 @@ If you want to exit cleanly, call `client.quit()` to send the `QUIT` command. console.log(reply.toString()); }); client.quit(); - -## client.connected - -Boolean tracking the state of the connection to the Redis server. - -## client.command_queue.length - -The number of commands that have been sent to the Redis server but not yet replied to. You can use this to -enforce some kind of maximum queue depth for commands while connected. - -Don't mess with `client.command_queue` though unless you really know what you are doing. - -## client.offline_queue.length - -The number of commands that have been queued up for a future connection. You can use this to enforce -some kind of maximum queue depth for pre-connection commands. - -## client.retry_delay - -Current delay in milliseconds before a connection retry will be attempted. This starts at `250`. - -## client.retry_backoff - -Multiplier for future retry timeouts. This should be larger than 1 to add more time between retries. -Defaults to 1.7. The default initial connection retry is 250, so the second retry will be 425, followed by 723.5, etc. ## Publish / Subscribe @@ -292,6 +268,32 @@ this library is updated, you can use `send_command()` to send arbitrary commands All commands are sent as multi-bulk commands. `args` can either be an Array of arguments, or individual arguments, or omitted completely. +## client.connected + +Boolean tracking the state of the connection to the Redis server. + +## client.command_queue.length + +The number of commands that have been sent to the Redis server but not yet replied to. You can use this to +enforce some kind of maximum queue depth for commands while connected. + +Don't mess with `client.command_queue` though unless you really know what you are doing. + +## client.offline_queue.length + +The number of commands that have been queued up for a future connection. You can use this to enforce +some kind of maximum queue depth for pre-connection commands. + +## client.retry_delay + +Current delay in milliseconds before a connection retry will be attempted. This starts at `250`. + +## client.retry_backoff + +Multiplier for future retry timeouts. This should be larger than 1 to add more time between retries. +Defaults to 1.7. The default initial connection retry is 250, so the second retry will be 425, followed by 723.5, etc. + + ## TODO Need to implement WATCH/UNWATCH and progressive MULTI commands.