Improve ColorResolvable docs

This commit is contained in:
Schuyler Cebulskie
2017-11-18 23:34:34 -05:00
parent a2074e8f25
commit f4ac06024e

View File

@@ -227,39 +227,34 @@ class Util {
} }
/** /**
* Can be a Hex Literal, Hex String, Number, RGB Array, or one of the following * Can be a number, hex string, an RGB array like:
* ```js
* [255, 0, 255] // purple
* ``` * ```
* [ * or one of the following strings:
* 'DEFAULT', * - `DEFAULT`
* 'AQUA', * - `AQUA`
* 'GREEN', * - `GREEN`
* 'BLUE', * - `BLUE`
* 'PURPLE', * - `PURPLE`
* 'GOLD', * - `GOLD`
* 'ORANGE', * - `ORANGE`
* 'RED', * - `RED`
* 'GREY', * - `GREY`
* 'DARKER_GREY', * - `DARKER_GREY`
* 'NAVY', * - `NAVY`
* 'DARK_AQUA', * - `DARK_AQUA`
* 'DARK_GREEN', * - `DARK_GREEN`
* 'DARK_BLUE', * - `DARK_BLUE`
* 'DARK_PURPLE', * - `DARK_PURPLE`
* 'DARK_GOLD', * - `DARK_GOLD`
* 'DARK_ORANGE', * - `DARK_ORANGE`
* 'DARK_RED', * - `DARK_RED`
* 'DARK_GREY', * - `DARK_GREY`
* 'LIGHT_GREY', * - `LIGHT_GREY`
* 'DARK_NAVY', * - `DARK_NAVY`
* 'RANDOM', * - `RANDOM`
* ] * @typedef {string|number|number[]} ColorResolvable
* ```
* or something like
* ```
* [255, 0, 255]
* ```
* for purple
* @typedef {string|number|Array} ColorResolvable
*/ */
/** /**
@@ -275,11 +270,8 @@ class Util {
color = (color[0] << 16) + (color[1] << 8) + color[2]; color = (color[0] << 16) + (color[1] << 8) + color[2];
} }
if (color < 0 || color > 0xFFFFFF) { if (color < 0 || color > 0xFFFFFF) throw new RangeError('COLOR_RANGE');
throw new RangeError('COLOR_RANGE'); else if (color && isNaN(color)) throw new TypeError('COLOR_CONVERT');
} else if (color && isNaN(color)) {
throw new TypeError('COLOR_CONVERT');
}
return color; return color;
} }