Added XHRSettings Conf

src/loader/File.js

@@ -89,7 +89,7 @@ var File = new Class({
          * The merged XHRSettings for this file.
          *
          * @name Phaser.Loader.File#xhrSettings
-         * @type {Phaser.Loader.XHRSettings}
+         * @type {Phaser.Loader.XHRSettingsConfig}
          * @since 3.0.0
          */
         this.xhrSettings = XHRSettings(GetFastValue(fileConfig, 'responseType', undefined));
@@ -109,10 +109,10 @@ var File = new Class({
         this.loader = null;
 
         /**
-         * The XHR Loader instance that is loading this File.
+         * The XHR Loader function that is loading this File.
          *
          * @name Phaser.Loader.File#xhrLoader
-         * @type {?Phaser.Loader.XHRLoader}
+         * @type {?function}
          * @since 3.0.0
          */
         this.xhrLoader = null;
@@ -404,7 +404,7 @@ var File = new Class({
  *
  * @method Phaser.Loader.File.createObjectURL
  * @static
- * @param {Image} image - Image object which 'src' attribute should be set to object URL.
+ * @param {HTMLImageElement} image - Image object which 'src' attribute should be set to object URL.
  * @param {Blob} blob - A Blob object to create an object URL for.
  * @param {string} defaultType - Default mime type used if blob type is not available.
  */
@@ -436,7 +436,7 @@ File.createObjectURL = function (image, blob, defaultType)
  *
  * @method Phaser.Loader.File.revokeObjectURL
  * @static
- * @param {Image} image - Image object which 'src' attribute should be revoked.
+ * @param {HTMLImageElement} image - Image object which 'src' attribute should be revoked.
  */
 File.revokeObjectURL = function (image)
 {

src/loader/LoaderPlugin.js

@@ -122,7 +122,7 @@ var LoaderPlugin = new Class({
          * xhr specific global settings (can be overridden on a per-file basis)
          *
          * @name Phaser.Loader.LoaderPlugin#xhr
-         * @type {Phaser.Loader.XHRSettings}
+         * @type {Phaser.Loader.XHRSettingsConfig}
          * @since 3.0.0
          */
         this.xhr = XHRSettings(

src/loader/MergeXHRSettings.js

@@ -16,10 +16,10 @@ var XHRSettings = require('./XHRSettings');
  * @function Phaser.Loader.MergeXHRSettings
  * @since 3.0.0
  *
- * @param {Phaser.Loader.XHRSettings} global - The global XHRSettings object.
+ * @param {Phaser.Loader.XHRSettingsConfig} global - The global XHRSettings object.
- * @param {Phaser.Loader.XHRSettings} local - The local XHRSettings object.
+ * @param {Phaser.Loader.XHRSettingsConfig} local - The local XHRSettings object.
  *
- * @return {Phaser.Loader.XHRSettings} A newly formed XHRSettings object.
+ * @return {Phaser.Loader.XHRSettingsConfig} A newly formed XHRSettings object.
  */
 var MergeXHRSettings = function (global, local)
 {

src/loader/XHRLoader.js

@@ -15,7 +15,7 @@ var MergeXHRSettings = require('./MergeXHRSettings');
  * @since 3.0.0
  *
  * @param {Phaser.Loader.File} file - The File to download.
- * @param {Phaser.Loader.XHRSettings} globalXHRSettings - The global XHRSettings object.
+ * @param {Phaser.Loader.XHRSettingsConfig} globalXHRSettings - The global XHRSettings object.
  *
  * @return {XMLHttpRequest} The XHR object.
  */

src/loader/XHRSettings.js

@@ -4,19 +4,29 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
+/**
+ * @typedef {object} Phaser.Loader.XHRSettingsConfig
+ *
+ * @property {string} [responseType=''] - [description]
+ * @property {boolean} [async=true] - [description]
+ * @property {string} [user=''] - [description]
+ * @property {string} [password=''] - [description]
+ * @property {integer} [timeout=0] - [description]
+ */
+
 /**
  * Creates an XHRSettings Object with default values.
  *
  * @function Phaser.Loader.XHRSettings
  * @since 3.0.0
  *
- * @param {string} [responseType] - The responseType, such as 'text'.
+ * @param {string} [responseType=''] - The responseType, such as 'text'.
  * @param {boolean} [async=true] - Should the XHR request use async or not?
- * @param {string} [user] - Optional username for the XHR request.
+ * @param {string} [user=''] - Optional username for the XHR request.
- * @param {string} [password] - Optional password for the XHR request.
+ * @param {string} [password=''] - Optional password for the XHR request.
  * @param {integer} [timeout=0] - Optional XHR timeout value.
  *
- * @return {Phaser.Loader.XHRSettings} The XHRSettings object as used by the Loader.
+ * @return {Phaser.Loader.XHRSettingsConfig} The XHRSettings object as used by the Loader.
  */
 var XHRSettings = function (responseType, async, user, password, timeout)
 {

src/loader/filetypes/AnimationJSONFile.js

@@ -16,9 +16,9 @@ var JSONFile = require('./JSONFile.js');
  * @param {string} key - The key of the file within the loader.
  * @param {string} url - The url to load the file from.
  * @param {string} path - The path of the file.
- * @param {object} xhrSettings - Optional file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - Optional file specific XHR settings.
  *
- * @return {Phaser.Loader.FileTypes.AnimationJSONFile} A File instance to be added to the Loader.
+ * @return {Phaser.Loader.FileTypes.JSONFile} A File instance to be added to the Loader.
  */
 var AnimationJSONFile = function (key, url, path, xhrSettings)
 {

src/loader/filetypes/AtlasJSONFile.js

@@ -18,8 +18,8 @@ var JSONFile = require('./JSONFile.js');
  * @param {string} textureURL - The url to load the texture file from.
  * @param {string} atlasURL - The url to load the atlas file from.
  * @param {string} path - The path of the file.
- * @param {object} textureXhrSettings - Optional texture file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} textureXhrSettings - Optional texture file specific XHR settings.
- * @param {object} atlasXhrSettings - Optional atlas file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} atlasXhrSettings - Optional atlas file specific XHR settings.
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */

src/loader/filetypes/AudioFile.js

@@ -24,7 +24,7 @@ var HTML5AudioFile = require('./HTML5AudioFile');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  * @param {AudioContext} audioContext - [description]
  */
 var AudioFile = new Class({

src/loader/filetypes/AudioSprite.js

@@ -24,8 +24,8 @@ var JSONFile = require('./JSONFile.js');
  * @param {(string|string[])} urls - [description]
  * @param {object} json - [description]
  * @param {object} config - [description]
- * @param {object} audioXhrSettings - Optional file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} audioXhrSettings - Optional file specific XHR settings.
- * @param {object} jsonXhrSettings - Optional file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} jsonXhrSettings - Optional file specific XHR settings.
  *
  * @return {Phaser.Loader.LoaderPlugin} The Loader.
  */

src/loader/filetypes/BinaryFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var BinaryFile = new Class({
 

src/loader/filetypes/BitmapFontFile.js

@@ -18,8 +18,8 @@ var XMLFile = require('./XMLFile.js');
  * @param {string} textureURL - The url to load the texture file from.
  * @param {string} xmlURL - The url to load the atlas file from.
  * @param {string} path - The path of the file.
- * @param {object} textureXhrSettings - Optional texture file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} textureXhrSettings - Optional texture file specific XHR settings.
- * @param {object} xmlXhrSettings - Optional atlas file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} xmlXhrSettings - Optional atlas file specific XHR settings.
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */

src/loader/filetypes/GLSLFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var GLSLFile = new Class({
 

src/loader/filetypes/HTML5AudioFile.js

@@ -22,7 +22,7 @@ var GetURL = require('../GetURL');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} config - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} config - [description]
  * @param {boolean} locked - [description]
  */
 var HTML5AudioFile = new Class({

src/loader/filetypes/HTMLFile.js

@@ -25,7 +25,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {number} width - [description]
  * @param {number} height - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var HTMLFile = new Class({
 

src/loader/filetypes/ImageFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  * @param {object} config - [description]
  */
 var ImageFile = new Class({

src/loader/filetypes/JSONFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var JSONFile = new Class({
 

src/loader/filetypes/MultiAtlas.js

@@ -23,8 +23,8 @@ var NumberArray = require('../../utils/array/NumberArray');
  * @param {string} key - [description]
  * @param {string[]} textureURLs - [description]
  * @param {string[]} atlasURLs - [description]
- * @param {object} textureXhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} textureXhrSettings - [description]
- * @param {object} atlasXhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} atlasXhrSettings - [description]
  * 
  * @return {Phaser.Loader.LoaderPlugin} The Loader.
  */

src/loader/filetypes/PluginFile.js

@@ -24,7 +24,7 @@ var PluginManager = require('../../boot/PluginManager');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var PluginFile = new Class({
 

src/loader/filetypes/SVGFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var SVGFile = new Class({
 

src/loader/filetypes/ScriptFile.js

@@ -23,7 +23,7 @@ var GetFastValue = require('../../utils/object/GetFastValue');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var ScriptFile = new Class({
 

src/loader/filetypes/SpriteSheetFile.js

@@ -17,7 +17,7 @@ var ImageFile = require('./ImageFile.js');
  * @param {string} url - The url to load the texture file from.
  * @param {object} config - Optional texture file specific XHR settings.
  * @param {string} path - Optional texture file specific XHR settings.
- * @param {object} xhrSettings - Optional atlas file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - Optional atlas file specific XHR settings.
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */

src/loader/filetypes/TextFile.js

@@ -22,7 +22,7 @@ var FileTypesManager = require('../FileTypesManager');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var TextFile = new Class({
 

src/loader/filetypes/TilemapCSVFile.js

@@ -24,7 +24,7 @@ var TILEMAP_FORMATS = require('../../tilemaps/Formats');
  * @param {string} url - [description]
  * @param {string} path - [description]
  * @param {string} format - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var TilemapCSVFile = new Class({
 

src/loader/filetypes/TilemapJSONFile.js

@@ -18,7 +18,7 @@ var TILEMAP_FORMATS = require('../../tilemaps/Formats');
  * @param {string} url - [description]
  * @param {string} path - [description]
  * @param {string} format - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */

src/loader/filetypes/UnityAtlasFile.js

@@ -18,8 +18,8 @@ var TextFile = require('./TextFile.js');
  * @param {string} textureURL - The url to load the texture file from.
  * @param {string} atlasURL - The url to load the atlas file from.
  * @param {string} path - The path of the file.
- * @param {object} textureXhrSettings - Optional texture file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} textureXhrSettings - Optional texture file specific XHR settings.
- * @param {object} atlasXhrSettings - Optional atlas file specific XHR settings.
+ * @param {Phaser.Loader.XHRSettingsConfig} atlasXhrSettings - Optional atlas file specific XHR settings.
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */

src/loader/filetypes/XMLFile.js

@@ -24,7 +24,7 @@ var ParseXML = require('../../dom/ParseXML');
  * @param {string} key - [description]
  * @param {string} url - [description]
  * @param {string} path - [description]
- * @param {object} xhrSettings - [description]
+ * @param {Phaser.Loader.XHRSettingsConfig} xhrSettings - [description]
  */
 var XMLFile = new Class({