Merge pull request phaserjs#3425 from orblazer/fix-types

Add callbacks types

Author: photonstorm

src/actions/Call.js

@@ -4,14 +4,20 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
+/**
+ * @callback CallCallback
+ *
+ * @param {Phaser.GameObjects.GameObject} item - [description]
+ */
+
 /**
  * Takes an array of objects and passes each of them to the given callback.
  *
  * @function Phaser.Actions.Call
  * @since 3.0.0
- * 
+ *
  * @param {array|Phaser.GameObjects.GameObject[]} items - The array of items to be updated by this action.
- * @param {function} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
+ * @param {CallCallback} callback - The callback to be invoked. It will be passed just one argument: the item from the array.
  * @param {object} context - The scope in which the callback will be invoked.
  *
  * @return {array} The array of objects that was passed to this Action.

src/actions/SetHitArea.js

@@ -9,10 +9,10 @@
  *
  * @function Phaser.Actions.SetHitArea
  * @since 3.0.0
- * 
+ *
  * @param {array} items - An array of Game Objects. The contents of this array are updated by this Action.
  * @param {any} hitArea - [description]
- * @param {function} hitAreaCallback - [description]
+ * @param {HitAreaCallback} hitAreaCallback - [description]
  *
  * @return {array} The array of Game Objects that was passed to this Action.
  */

src/boot/Config.js

@@ -18,6 +18,12 @@ var ValueToColor = require('../display/color/ValueToColor');
  * @callback NOOP
  */
 
+/**
+ * @callback BootCallback
+ *
+ * @param {Phaser.Game} game - [description]
+ */
+
 /**
  * @typedef {object} FPSConfig
  *
@@ -86,8 +92,8 @@ var ValueToColor = require('../display/color/ValueToColor');
  * @property {boolean} [powerPreference='default'] - "high-performance", "low-power" or "default"
  * @property {string|number} [backgroundColor=0x000000] - [description]
  * @property {object} [?callbacks] - [description]
- * @property {function} [callbacks.preBoot=NOOP] - [description]
- * @property {function} [callbacks.postBoot=NOOP] - [description]
+ * @property {BootCallback} [callbacks.preBoot=NOOP] - [description]
+ * @property {BootCallback} [callbacks.postBoot=NOOP] - [description]
  * @property {LoaderConfig} [?loader] - [description]
  * @property {object} [?images] - [description]
  * @property {string} [images.default] - [description]

src/boot/Game.js

@@ -25,6 +25,10 @@ var TextureManager = require('../textures/TextureManager');
 var TimeStep = require('./TimeStep');
 var VisibilityHandler = require('./VisibilityHandler');
 
+/**
+ * @callback GameStepCallback
+ */
+
 /**
  * @classdesc
  * The Phaser.Game instance is the main controller for the entire Phaser game. It is responsible
@@ -232,7 +236,7 @@ var Game = new Class({
          * It is set automatically when the Game boot process has completed.
          *
          * @name Phaser.Game#onStepCallback
-         * @type {function}
+         * @type {GameStepCallback}
          * @private
          * @since 3.0.0
          */

src/boot/TimeStep.js

@@ -20,6 +20,14 @@ var RequestAnimationFrame = require('../dom/RequestAnimationFrame');
 
 // http://www.testufo.com/#test=animation-time-graph
 
+/**
+ * @callback TimeStepCallback
+ *
+ * @param {number} time - The current time. Either a High Resolution Timer value if it comes from Request Animation Frame, or Date.now if using SetTimeout.
+ * @param {number} average - The Delta Average.
+ * @param {number} interpolation - Interpolation - how far between what is expected and where we are?
+ */
+
 /**
  * @classdesc
  * [description]
@@ -78,7 +86,7 @@ var TimeStep = new Class({
          * @since 3.0.0
          */
         this.running = false;
-        
+
         /**
          * The minimum fps rate you want the Time Step to run at.
          *
@@ -90,7 +98,7 @@ var TimeStep = new Class({
 
         /**
          * The target fps rate for the Time Step to run at.
-         * 
+         *
          * Setting this value will not actually change the speed at which the browser runs, that is beyond
          * the control of Phaser. Instead, it allows you to determine performance issues and if the Time Step
          * is spiraling out of control.
@@ -154,7 +162,7 @@ var TimeStep = new Class({
         /**
          * A callback to be invoked each time the Time Step steps.
          *
-         * @property {function} callback
+         * @property {TimeStepCallback} callback
          * @default NOOP
          * @since 3.0.0
          */
@@ -379,7 +387,7 @@ var TimeStep = new Class({
      * @method Phaser.Boot.TimeStep#start
      * @since 3.0.0
      *
-     * @param {function} callback - The callback to be invoked each time the Time Step steps.
+     * @param {TimeStepCallback} callback - The callback to be invoked each time the Time Step steps.
      */
     start: function (callback)
     {
@@ -544,7 +552,7 @@ var TimeStep = new Class({
         if (this.running)
         {
             this.raf.stop();
-            
+
             this.running = false;
         }
     },

src/create/GenerateTexture.js

@@ -8,6 +8,13 @@ var Arne16 = require('./palettes/Arne16');
 var CanvasPool = require('../display/canvas/CanvasPool');
 var GetValue = require('../utils/object/GetValue');
 
+/**
+ * @callback GenerateTextureRendererCallback
+ *
+ * @param {HTMLCanvasElement} canvas - [description]
+ * @param {CanvasRenderingContext2D} context - [description]
+ */
+
 /**
  * @typedef {object} GenerateTextureConfig
  *
@@ -18,8 +25,8 @@ var GetValue = require('../utils/object/GetValue');
  * @property {number} [pixelHeight=1] - [description]
  * @property {boolean} [resizeCanvas=true] - [description]
  * @property {boolean} [clearCanvas=true] - [description]
- * @property {function} [preRender] - [description]
- * @property {function} [postRender] - [description]
+ * @property {GenerateTextureRendererCallback} [preRender] - [description]
+ * @property {GenerateTextureRendererCallback} [postRender] - [description]
  */
 
 /**

src/data/DataManager.js

@@ -6,6 +6,15 @@
 
 var Class = require('../utils/Class');
 
+/**
+ * @callback DataEachCallback
+ *
+ * @param {any} parent - [description]
+ * @param {string} key - [description]
+ * @param {any} value - [description]
+ * @param {...*} [arguments] - Additional arguments that will be passed to the callback, after the game object, key, and data.
+ */
+
 /**
  * @classdesc
  * The Data Component features a means to store pieces of data specific to a Game Object, System or Plugin.
@@ -199,7 +208,7 @@ var DataManager = new Class({
      * @method Phaser.Data.DataManager#each
      * @since 3.0.0
      *
-     * @param {function} callback - The function to call.
+     * @param {DataEachCallback} callback - The function to call.
      * @param {object} [scope] - Value to use as `this` when executing callback.
      * @param {...*} [arguments] - Additional arguments that will be passed to the callback, after the game object, key, and data.
      *

src/dom/DOMContentLoaded.js

@@ -6,6 +6,10 @@
 
 var OS = require('../device/OS');
 
+/**
+ * @callback ContentLoadedCallback
+ */
+
 /**
  * Inspects the readyState of the document. If the document is already complete then it invokes the given callback.
  * If not complete it sets up several event listeners such as `deviceready`, and once those fire, it invokes the callback.
@@ -14,7 +18,7 @@ var OS = require('../device/OS');
  * @function Phaser.DOM.DOMContentLoaded
  * @since 3.0.0
  *
- * @param {function} callback - The callback to be invoked when the device is ready and the DOM content is loaded.
+ * @param {ContentLoadedCallback} callback - The callback to be invoked when the device is ready and the DOM content is loaded.
  */
 var DOMContentLoaded = function (callback)
 {

src/dom/RequestAnimationFrame.js

@@ -37,7 +37,7 @@ var RequestAnimationFrame = new Class({
          * The callback to be invoked each step.
          *
          * @name Phaser.DOM.RequestAnimationFrame#callback
-         * @type {function}
+         * @type {FrameRequestCallback}
          * @since 3.0.0
          */
         this.callback = NOOP;
@@ -89,7 +89,7 @@ var RequestAnimationFrame = new Class({
          * Updates the local tick value, invokes the callback and schedules another call to requestAnimationFrame.
          *
          * @name Phaser.DOM.RequestAnimationFrame#step
-         * @type {function}
+         * @type {FrameRequestCallback}
          * @since 3.0.0
          */
         this.step = function step (timestamp)
@@ -134,7 +134,7 @@ var RequestAnimationFrame = new Class({
      * @method Phaser.DOM.RequestAnimationFrame#start
      * @since 3.0.0
      *
-     * @param {function} callback - The callback to invoke each step.
+     * @param {FrameRequestCallback} callback - The callback to invoke each step.
      * @param {boolean} forceSetTimeOut - Should it use SetTimeout, even if RAF is available?
      */
     start: function (callback, forceSetTimeOut)

src/gameobjects/GameObject.js

@@ -254,7 +254,7 @@ var GameObject = new Class({
      * @since 3.0.0
      *
      * @param {any} [shape] - A geometric shape that defines the hit area for the Game Object. If not specified a Rectangle will be used.
-     * @param {function} [callback] - A callback to be invoked when the Game Object is interacted with.
+     * @param {HitAreaCallback} [callback] - A callback to be invoked when the Game Object is interacted with.
      * @param {boolean} [dropZone=false] - Should this Game Object be treated as a drop zone target?
      *
      * @return {Phaser.GameObjects.GameObject} This GameObject.