Skip to content

Commit

Permalink
docs: fix doc for keepAlive option
Browse files Browse the repository at this point in the history
  • Loading branch information
luin committed Feb 7, 2016
1 parent e528057 commit 3e68925
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ Creates a Redis instance
| [options.host] | <code>string</code> | <code>&quot;localhost&quot;</code> | Host of the Redis server. |
| [options.family] | <code>string</code> | <code>4</code> | Version of IP stack. Defaults to 4. |
| [options.path] | <code>string</code> | <code>null</code> | Local domain socket path. If set the `port`, `host` and `family` will be ignored. |
| [options.keepAlive] | <code>number</code> | <code>0</code> | TCP KeepAlive on the socket with a X ms delay before start. |
| [options.connectionName] | <code>string</code> | <code>null</code> | Connection name. Set to a non-number value to disable keepAlive. |
| [options.keepAlive] | <code>number</code> | <code>0</code> | TCP KeepAlive on the socket with a X ms delay before start. Set to a non-number value to disable keepAlive. |
| [options.connectionName] | <code>string</code> | <code>null</code> | Connection name. |
| [options.db] | <code>number</code> | <code>0</code> | Database index to use. |
| [options.password] | <code>string</code> | <code>null</code> | If set, client will send AUTH command with the value of this option when connected. |
| [options.enableReadyCheck] | <code>boolean</code> | <code>true</code> | When a connection is established to the Redis server, the server might still be loading the database from disk. While loading, the server not respond to any commands. To work around this, when this option is `true`, ioredis will check the status of the Redis server, and when the Redis server is able to process commands, a `ready` event will be emitted. |
Expand Down
2 changes: 1 addition & 1 deletion lib/redis.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var ScanStream = require('./scan_stream');
* @param {string} [options.path=null] - Local domain socket path. If set the `port`,
* `host` and `family` will be ignored.
* @param {number} [options.keepAlive=0] - TCP KeepAlive on the socket with a X ms delay before start.
* @param {string} [options.connectionName=null] - Connection name.
* Set to a non-number value to disable keepAlive.
* @param {string} [options.connectionName=null] - Connection name.
* @param {number} [options.db=0] - Database index to use.
* @param {string} [options.password=null] - If set, client will send AUTH command
* with the value of this option when connected.
Expand Down
2 changes: 1 addition & 1 deletion lib/redis/event_handler.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ exports.readyHandler = function (self) {
self.condition.select = 0;

if (self.options.connectionName) {
debug('set the connection mane [%s]', self.options.connectionName);
debug('set the connection name [%s]', self.options.connectionName);
self.client('setname', self.options.connectionName);
}

Expand Down

0 comments on commit 3e68925

Please # to comment.