summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/lib/utils/common_utils.js
diff options
context:
space:
mode:
authorWinnie Hellmann <winnie@gitlab.com>2018-12-05 11:49:53 +0100
committerWinnie Hellmann <winnie@gitlab.com>2018-12-05 11:49:53 +0100
commit718479b527e917344a880450fe5781b407d80b80 (patch)
treecbb7065ec3b5e88fc129a620a85aeb5a43df4cef /app/assets/javascripts/lib/utils/common_utils.js
parent0515ace283e4892da437831692b2bb8b073eb0fc (diff)
downloadgitlab-ce-winh-jsdoc.tar.gz
Fix some stuffwinh-jsdoc
Diffstat (limited to 'app/assets/javascripts/lib/utils/common_utils.js')
-rw-r--r--app/assets/javascripts/lib/utils/common_utils.js12
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 040d0bc659e..c262ae2d8e5 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';
@@ -445,10 +449,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