aboutsummaryrefslogtreecommitdiffstats
path: root/apps/comments/src/utils/cancelableRequest.js
diff options
context:
space:
mode:
Diffstat (limited to 'apps/comments/src/utils/cancelableRequest.js')
-rw-r--r--apps/comments/src/utils/cancelableRequest.js62
1 files changed, 62 insertions, 0 deletions
diff --git a/apps/comments/src/utils/cancelableRequest.js b/apps/comments/src/utils/cancelableRequest.js
new file mode 100644
index 00000000000..425e94a787a
--- /dev/null
+++ b/apps/comments/src/utils/cancelableRequest.js
@@ -0,0 +1,62 @@
+/**
+ * @copyright Copyright (c) 2020 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+import axios from '@nextcloud/axios'
+
+/**
+ * Create a cancel token
+ * @returns {CancelTokenSource}
+ */
+const createCancelToken = () => axios.CancelToken.source()
+
+/**
+ * Creates a cancelable axios 'request object'.
+ *
+ * @param {function} request the axios promise request
+ * @returns {Object}
+ */
+const cancelableRequest = function(request) {
+ /**
+ * Generate an axios cancel token
+ */
+ const cancelToken = createCancelToken()
+
+ /**
+ * Execute the request
+ *
+ * @param {string} url the url to send the request to
+ * @param {Object} [options] optional config for the request
+ */
+ const fetch = async function(url, options) {
+ return request(
+ url,
+ Object.assign({ cancelToken: cancelToken.token }, options)
+ )
+ }
+
+ return {
+ request: fetch,
+ cancel: cancelToken.cancel,
+ }
+}
+
+export default cancelableRequest