Added docs to XHRSettingsObject

This commit is contained in:
jorbascrumps 2019-06-25 19:30:05 -04:00
parent f77e0ccbc1
commit 32925001db

View file

@ -7,6 +7,7 @@
* @property {string} [user=''] - Optional username for the XHR request. * @property {string} [user=''] - Optional username for the XHR request.
* @property {string} [password=''] - Optional password for the XHR request. * @property {string} [password=''] - Optional password for the XHR request.
* @property {integer} [timeout=0] - Optional XHR timeout value. * @property {integer} [timeout=0] - Optional XHR timeout value.
* @property {(object|undefined)} [headers] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.
* @property {(string|undefined)} [header] - This value is used to populate the XHR `setRequestHeader` and is undefined by default. * @property {(string|undefined)} [header] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.
* @property {(string|undefined)} [headerValue] - This value is used to populate the XHR `setRequestHeader` and is undefined by default. * @property {(string|undefined)} [headerValue] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.
* @property {(string|undefined)} [requestedWith] - This value is used to populate the XHR `setRequestHeader` and is undefined by default. * @property {(string|undefined)} [requestedWith] - This value is used to populate the XHR `setRequestHeader` and is undefined by default.