Skip to content

Commit ea54b9f

Browse files
authored
doc: missing behavior documentation when setting queueTTL to 0 (#643)
The queueTTL option documentation is missing a crucial piece of information: when set to 0, queued requests never expire.
1 parent b574a88 commit ea54b9f

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

doc/7/core-classes/kuzzle/constructor/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Kuzzle SDK instance options.
4545
| `deprecationWarning` | <pre>boolean</pre><br />(`true`) | Show deprecation warning in development (hidden either way in production) |
4646
| `eventTimeout` | <pre>number</pre><br/>(`200`) | Time (in ms) during which a similar event is ignored |
4747
| `offlineMode` | <pre>string</pre><br/>(`manual`) | Offline mode configuration. Can be `manual` or `auto` |
48-
| `queueTTL` | <pre>number</pre><br/>(`120000`) | Time a queued request is kept during offline mode, in milliseconds |
48+
| `queueTTL` | <pre>number</pre><br/>(`120000`) | Time a queued request is kept during offline mode, in milliseconds. Set it to `0` to keep queued requests indefinitely |
4949
| `queueMaxSize` | <pre>number</pre><br/>(`500`) | Number of maximum requests kept during offline mode |
5050
| `replayInterval` | <pre>number</pre><br/>(`10`) | Delay between each replayed requests, in milliseconds |
5151
| `requestTimeout` | <pre>number</pre><br/> | Default time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely |

doc/7/essentials/offline-tools/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@ Default value: `500`
6565

6666
### queueTTL
6767

68-
A writable `number` defining the time in milliseconds a queued request is kept in the `offlineQueue`.
68+
A writable `number` defining the time in milliseconds a queued request is kept in the `offlineQueue`.
69+
70+
Setting this parameter to `0` disables this behavior, and prevents the SDK from expiring queued requests.
6971

7072
Default value: `120000`
7173

0 commit comments

Comments
 (0)