From 4f4c1d3be96c5dd8b5a250fdd4fc8708c27fe81f Mon Sep 17 00:00:00 2001 From: Jay Date: Thu, 2 Jun 2022 20:53:31 +0200 Subject: [PATCH] docs(core/dispatchRequest) --- lib/core/dispatchRequest.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/lib/core/dispatchRequest.js b/lib/core/dispatchRequest.js index 6ac7bc0..8788590 100644 --- a/lib/core/dispatchRequest.js +++ b/lib/core/dispatchRequest.js @@ -9,6 +9,10 @@ var normalizeHeaderName = require('../helpers/normalizeHeaderName'); /** * Throws a `CanceledError` if cancellation has been requested. + * + * @param {Object} config The config that is to be used for the request + * + * @returns {void} */ function throwIfCancellationRequested(config) { if (config.cancelToken) { @@ -24,6 +28,7 @@ function throwIfCancellationRequested(config) { * Dispatch a request to the server using the configured adapter. * * @param {object} config The config that is to be used for the request + * * @returns {Promise} The Promise to be fulfilled */ module.exports = function dispatchRequest(config) {