blob: b6344ce91236b1e44053884a61b04d580b02abd6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/**
* @copyright Copyright (c) 2019 Marco Ambrosini <marcoambrosini@pm.me>
*
* @author Marco Ambrosini <marcoambrosini@pm.me>
* @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'
/**
* Creates an axios 'cancelable request object'.
*
* @param {function} request the axios promise request
* @returns {Object} The cancelable requests
* `object.request`: the api request funtion with the cancel token associated to it.
* `object.cancel`: the cancel function, when call it's going to delete the request.
*/
const CancelableRequest = function(request) {
/**
* Generate an axios cancel token
*/
const CancelToken = axios.CancelToken
const source = CancelToken.source()
/**
* Execute the request
*
* @param {string} data the data to send the request to
* @param {object} [options] optional config for the request
* @returns { object }
*/
const fetch = async function(data, options) {
return request(
data,
Object.assign({ cancelToken: source.token }, options)
)
}
return {
request: fetch,
cancel: source.cancel,
}
}
// expose function to check if an exception is from a cancellation
CancelableRequest.isCancel = axios.isCancel
export default CancelableRequest
|
