docs(API): add docs for maxRetriesPerRequest option

redis · Jul 7, 2018 · 92696d5 · 92696d5
1 parent 33a49ee
commit 92696d5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -59,6 +59,7 @@ Creates a Redis instance
 | [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.maxRetriesPerRequest] | <code>number</code> |  | See "Quick Start" section |
 | [options.reconnectOnError] | <code>function</code> |  | See "Quick Start" section |
 | [options.readOnly] | <code>boolean</code> | <code>false</code> | Enable READONLY mode for the connection. Only available for cluster mode. |
 | [options.stringNumbers] | <code>boolean</code> | <code>false</code> | Force numbers to be always returned as JavaScript strings. This option is necessary when dealing with big numbers (exceed the [-2^53, +2^53] range). |

diff --git a/lib/redis.js b/lib/redis.js
@@ -79,6 +79,7 @@ var PromiseContainer = require('./promise_container');
  * @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 {number} [options.maxRetriesPerRequest] - See "Quick Start" section
  * @param {function} [options.reconnectOnError] - See "Quick Start" section
  * @param {boolean} [options.readOnly=false] - Enable READONLY mode for the connection.
  * Only available for cluster mode.