diff options
| author | Winnie Hellmann <winnie@gitlab.com> | 2019-01-15 00:46:21 +0300 |
|---|---|---|
| committer | Clement Ho <clemmakesapps@gmail.com> | 2019-01-15 00:46:21 +0300 |
| commit | 7999ca32241e785df539fc0d3a354f97bc2266a0 (patch) | |
| tree | 01d46a35ab2ebaac758a5f8a6b7924be83cbf8ad /app/assets/javascripts/lib/utils/common_utils.js | |
| parent | 3de1b521b7502adf380a241b2136d9cd0c17c4e3 (diff) | |
Generate searchable JSDoc documentation
Diffstat (limited to 'app/assets/javascripts/lib/utils/common_utils.js')
| -rw-r--r-- | app/assets/javascripts/lib/utils/common_utils.js | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/app/assets/javascripts/lib/utils/common_utils.js b/app/assets/javascripts/lib/utils/common_utils.js index fc34d243dd7..93b347ad09b 100644 --- a/app/assets/javascripts/lib/utils/common_utils.js +++ b/app/assets/javascripts/lib/utils/common_utils.js @@ -1,3 +1,7 @@ +/** + * @module common-utils + */ + import $ from 'jquery'; import axios from './axios_utils'; import { getLocationHash } from './url_utility'; @@ -450,10 +454,16 @@ export const convertPermissionToBoolean = permission => { }; /** + * @callback backOffCallback + * @param {Function} next + * @param {Function} stop + */ + +/** * Back Off exponential algorithm * backOff :: (Function<next, stop>, Number) -> Promise<Any, Error> * - * @param {Function<next, stop>} fn function to be called + * @param {backOffCallback} fn function to be called * @param {Number} timeout * @return {Promise<Any, Error>} * @example |