Skip to content

Commit

Permalink
docs(API): document the tls option
Browse files Browse the repository at this point in the history
Closes #577
  • Loading branch information
luin committed Apr 5, 2018
1 parent aed360d commit cc7d21a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Creates a Redis instance
| [options.autoResubscribe] | <code>boolean</code> | <code>true</code> | After reconnected, if the previous connection was in the subscriber mode, client will auto re-subscribe these channels. |
| [options.autoResendUnfulfilledCommands] | <code>boolean</code> | <code>true</code> | If true, client will resend unfulfilled commands(e.g. block commands) in the previous connection when reconnected. |
| [options.lazyConnect] | <code>boolean</code> | <code>false</code> | By default, When a new `Redis` instance is created, it will connect to Redis server automatically. If you want to keep disconnected util a command is called, you can pass the `lazyConnect` option to the constructor: ```javascript var redis = new Redis({ lazyConnect: true }); // No attempting to connect to the Redis server here. // Now let's connect to the Redis server redis.get('foo', function () { }); ``` |
| [options.tls] | <code>Object</code> | | TLS connection support. See https://github.com/luin/ioredis#tls-options |
| [options.keyPrefix] | <code>string</code> | <code>&quot;&#x27;&#x27;&quot;</code> | The prefix to prepend to all keys in a command. |
| [options.retryStrategy] | <code>function</code> | | See "Quick Start" section |
| [options.reconnectOnError] | <code>function</code> | | See "Quick Start" section |
Expand Down
1 change: 1 addition & 0 deletions lib/redis.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ var commands = require('redis-commands');
* redis.get('foo', function () {
* });
* ```
* @param {Object} [options.tls] - TLS connection support. See https://github.com/luin/ioredis#tls-options
* @param {string} [options.keyPrefix=''] - The prefix to prepend to all keys in a command.
* @param {function} [options.retryStrategy] - See "Quick Start" section
* @param {function} [options.reconnectOnError] - See "Quick Start" section
Expand Down

0 comments on commit cc7d21a

Please sign in to comment.