melonjs 10.2.0 → 10.3.0

package/src/utils/file.js

@@ -2,7 +2,7 @@
 /**
  * a collection of file utility functions
  * @namespace me.utils.file
- * @memberOf me
+ * @memberof me
  */
 
 // regexp to deal with file name & path
@@ -14,10 +14,10 @@ const REMOVE_EXT = /\.[^\.]*$/;
  * return the base name of the file without path info
  * @public
  * @function
- * @memberOf me.utils.file
+ * @memberof me.utils.file
  * @name getBasename
- * @param  {String} path path containing the filename
- * @return {String} the base name without path information.
+ * @param  {string} path path containing the filename
+ * @returns {string} the base name without path information.
  */
 export function getBasename(path) {
     return path.replace(REMOVE_PATH, "").replace(REMOVE_EXT, "");
@@ -27,10 +27,10 @@ export function getBasename(path) {
  * return the extension of the file in the given path
  * @public
  * @function
- * @memberOf me.utils.file
+ * @memberof me.utils.file
  * @name getExtension
- * @param  {String} path path containing the filename
- * @return {String} filename extension.
+ * @param  {string} path path containing the filename
+ * @returns {string} filename extension.
  */
 export function getExtension(path) {
     return path.substring(path.lastIndexOf(".") + 1, path.length);

package/src/utils/function.js

@@ -1,20 +1,19 @@
 /**
  * a collection of utility functions
  * @namespace me.utils.function
- * @memberOf me
+ * @memberof me
  */
 
-
 /**
  * Executes a function as soon as the interpreter is idle (stack empty).
  * @public
  * @function
- * @memberOf me.utils.function
+ * @memberof me.utils.function
  * @name defer
- * @param {Function} fn The function to be deferred.
- * @param {Object} thisArg The value to be passed as the this parameter to the target function when the deferred function is called
+ * @param {Function} func The function to be deferred.
+ * @param {object} thisArg The value to be passed as the this parameter to the target function when the deferred function is called
  * @param {...*} [args] Optional additional arguments to carry for the function.
- * @return {Number} id that can be used to clear the deferred function using
+ * @returns {number} id that can be used to clear the deferred function using
  * clearTimeout
  * @example
  * // execute myFunc() when the stack is empty,
@@ -30,11 +29,12 @@ export function defer(func, thisArg, ...args) {
  * once during a given window of time
  * @public
  * @function
- * @memberOf me.utils.function
+ * @memberof me.utils.function
  * @name throttle
  * @param {Function} fn the function to be throttled.
- * @param {Number} delay The delay in ms
+ * @param {number} delay The delay in ms
  * @param {no_trailing} no_trailing disable the execution on the trailing edge
+ * @returns {Function} the function that will be throttled
  */
 export function throttle(fn, delay, no_trailing) {
     var last = window.performance.now(), deferTimer;

package/src/utils/string.js

@@ -1,7 +1,7 @@
 /**
  * a collection of string utility functions
  * @namespace me.utils.string
- * @memberOf me
+ * @memberof me
  */
 
 
@@ -9,10 +9,10 @@
  * converts the first character of the given string to uppercase
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name capitalize
- * @param {String} string the string to be capitalized
- * @return {string} the capitalized string
+ * @param {string} str the string to be capitalized
+ * @returns {string} the capitalized string
  */
 export function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
@@ -22,10 +22,10 @@ export function capitalize(str) {
  * returns the string stripped of whitespace from the left.
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name trimLeft
- * @param {String} string the string to be trimmed
- * @return {string} trimmed string
+ * @param {string} str the string to be trimmed
+ * @returns {string} trimmed string
  */
 export function trimLeft(str) {
     return str.replace(/^\s+/, "");
@@ -35,10 +35,10 @@ export function trimLeft(str) {
  * returns the string stripped of whitespace from the right.
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name trimRight
- * @param {String} string the string to be trimmed
- * @return {string} trimmed string
+ * @param {string} str the string to be trimmed
+ * @returns {string} trimmed string
  */
 export function trimRight(str) {
     return str.replace(/\s+$/, "");
@@ -48,10 +48,10 @@ export function trimRight(str) {
  * returns true if the given string contains a numeric integer or float value
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name isNumeric
- * @param {String} string the string to be tested
- * @return {Boolean} true if string contains only digits
+ * @param {string} str the string to be tested
+ * @returns {boolean} true if string contains only digits
  */
 export function isNumeric(str) {
     if (typeof str === "string") {
@@ -64,10 +64,10 @@ export function isNumeric(str) {
  * returns true if the given string contains a true or false
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name isBoolean
- * @param {String} string the string to be tested
- * @return {Boolean} true if the string is either true or false
+ * @param {string} str the string to be tested
+ * @returns {boolean} true if the string is either true or false
  */
 export function isBoolean(str) {
     var trimmed = str.trim();
@@ -78,10 +78,10 @@ export function isBoolean(str) {
  * convert a string to the corresponding hexadecimal value
  * @public
  * @function
- * @memberOf me.utils.string
+ * @memberof me.utils.string
  * @name toHex
- * @param {String} string the string to be converted
- * @return {String}
+ * @param {string} str the string to be converted
+ * @returns {string} the converted hexadecimal value
  */
 export function toHex(str) {
     var res = "", c = 0;

package/src/utils/utils.js

@@ -10,7 +10,7 @@ import { version } from "./../index.js";
 /**
  * a collection of utility functions
  * @namespace utils
- * @memberOf me
+ * @memberof me
  */
 
 // guid default value
@@ -29,22 +29,22 @@ var utils = {
      * Get image pixels
      * @public
      * @function
-     * @memberOf me.utils
+     * @memberof me.utils
      * @name getPixels
-     * @param {Image|Canvas} image Image to read
-     * @return {ImageData} Canvas ImageData object
+     * @param {HTMLImageElement|HTMLCanvasElement} image Image to read
+     * @returns {ImageData} ImageData object
      */
-    getPixels : function (arg) {
-        if (arg instanceof HTMLImageElement) {
+    getPixels : function (image) {
+        if (image instanceof HTMLImageElement) {
             var _context = CanvasRenderer.getContext2d(
-                createCanvas(arg.width, arg.height)
+                createCanvas(image.width, image.height)
             );
-            _context.drawImage(arg, 0, 0);
-            return _context.getImageData(0, 0, arg.width, arg.height);
+            _context.drawImage(image, 0, 0);
+            return _context.getImageData(0, 0, image.width, image.height);
         }
         else {
             // canvas !
-            return arg.getContext("2d").getImageData(0, 0, arg.width, arg.height);
+            return image.getContext("2d").getImageData(0, 0, image.width, image.height);
         }
     },
 
@@ -52,11 +52,11 @@ var utils = {
      * Compare two version strings
      * @public
      * @function
-     * @memberOf me.utils
+     * @memberof me.utils
      * @name checkVersion
-     * @param {String} first First version string to compare
-     * @param {String} [second=me.version] Second version string to compare
-     * @return {Number} comparison result <br>&lt; 0 : first &lt; second<br>
+     * @param {string} first First version string to compare
+     * @param {string} [second=me.version] Second version string to compare
+     * @returns {number} comparison result <br>&lt; 0 : first &lt; second<br>
      * 0 : first == second<br>
      * &gt; 0 : first &gt; second
      * @example
@@ -85,16 +85,16 @@ var utils = {
      * parse the fragment (hash) from a URL and returns them into
      * @public
      * @function
-     * @memberOf me.utils
+     * @memberof me.utils
      * @name getUriFragment
-     * @param {String} [url=document.location] an optional params string or URL containing fragment (hash) params to be parsed
-     * @return {Object} an object representing the deserialized params string.
-     * @property {Boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
-     * @property {Boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
-     * @property {Boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
-     * @property {Boolean} [webgl=false] force the renderer to WebGL
-     * @property {Boolean} [debug=false] display the debug panel (if preloaded)
-     * @property {String} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
+     * @param {string} [url=document.location] an optional params string or URL containing fragment (hash) params to be parsed
+     * @returns {object} an object representing the deserialized params string.
+     * @property {boolean} [hitbox=false] draw the hitbox in the debug panel (if enabled)
+     * @property {boolean} [velocity=false] draw the entities velocity in the debug panel (if enabled)
+     * @property {boolean} [quadtree=false] draw the quadtree in the debug panel (if enabled)
+     * @property {boolean} [webgl=false] force the renderer to WebGL
+     * @property {boolean} [debug=false] display the debug panel (if preloaded)
+     * @property {string} [debugToggleKey="s"] show/hide the debug panel (if preloaded)
      * @example
      * // http://www.example.com/index.html#debug&hitbox=true&mytag=value
      * var UriFragment = me.utils.getUriFragment();