diff options
| author | Simon Knox <psimyn@gmail.com> | 2017-10-31 15:25:52 +0300 |
|---|---|---|
| committer | Simon Knox <psimyn@gmail.com> | 2017-10-31 15:25:52 +0300 |
| commit | 17f2ba7facb64268ef14f6c29e79cf0e240c78d9 (patch) | |
| tree | 1443b06a7e8e65af25f7caa318b964779e69ea7b /app/assets/javascripts/smart_interval.js | |
| parent | f3ae99fa9d9ebe78319359ce8d6855e68af81aaf (diff) | |
update docstring
Diffstat (limited to 'app/assets/javascripts/smart_interval.js')
| -rw-r--r-- | app/assets/javascripts/smart_interval.js | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/app/assets/javascripts/smart_interval.js b/app/assets/javascripts/smart_interval.js index 89e7a4ebc5c..f7cddc7e874 100644 --- a/app/assets/javascripts/smart_interval.js +++ b/app/assets/javascripts/smart_interval.js @@ -5,7 +5,7 @@ export default class SmartInterval { /** - * @param { function } opts.callback Function to be called on each iteration (required) + * @param { function } opts.callback A Promise, called on each iteration (required) unless still in progress * @param { milliseconds } opts.startingInterval `currentInterval` is set to this initially * @param { milliseconds } opts.maxInterval `currentInterval` will be incremented to this * @param { milliseconds } opts.hiddenInterval `currentInterval` is set to this |