From 4c088123026e520f46cb4ee21bb90140d2501215 Mon Sep 17 00:00:00 2001 From: Gryffon Bellish <39341355+PyroTechniac@users.noreply.github.com> Date: Mon, 26 Aug 2019 12:52:30 -0400 Subject: [PATCH] docs(ClientOptions): document unit of restRequestTimeout (#3449) --- src/util/Constants.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/util/Constants.js b/src/util/Constants.js index 50033919d..a344f6536 100644 --- a/src/util/Constants.js +++ b/src/util/Constants.js @@ -28,7 +28,7 @@ const browser = exports.browser = typeof window !== 'undefined'; * corresponding websocket events * @property {number} [restTimeOffset=500] Extra time in millseconds to wait before continuing to make REST * requests (higher values will reduce rate-limiting errors on bad connections) - * @property {number} [restRequestTimeout=15000] Time to wait before cancelling a REST request + * @property {number} [restRequestTimeout=15000] Time to wait before cancelling a REST request, in milliseconds * @property {number} [restSweepInterval=60] How frequently to delete inactive request buckets, in seconds * (or 0 for never) * @property {number} [retryLimit=1] How many times to retry on 5XX errors (Infinity for indefinite amount of retries)