Merge pull request #3273 from nakakura/pleasejs-add

add Typings for PleaseJS

pleasejs/please-tests.ts

@@ -0,0 +1,62 @@
+///<reference path="please.d.ts" />
+
+Please.make_color();
+
+Please.make_color({
+    golden: false,
+    base_color: 'red',
+    colors_returned: 100,
+    format: 'rgb-string'
+});
+
+Please.make_scheme({
+    h: 145,
+    s: .7,
+    v: .6
+});
+
+Please.make_scheme(
+    {
+        h: 145,
+        s: .7,
+        v: .6
+    },
+    {
+        scheme_type: 'complement',
+        format: 'hex'
+    }
+);
+
+Please.NAME_to_HEX("red");
+
+Please.NAME_to_HSV("red");
+
+Please.NAME_to_RGB("red");
+
+Please.HEX_to_HSV("#ff0000");
+
+Please.RGB_to_HEX({
+    r: 0,
+    g: 0,
+    b: 0
+});
+
+Please.HSV_to_RGB({
+    h: 145,
+    s: .7,
+    v: .6
+});
+
+Please.RGB_to_HSV({
+    r: 0,
+    g: 0,
+    b: 0
+});
+
+Please.HSV_to_HEX({
+    h: 145,
+    s: .7,
+    v: .6
+});
+
+Please.HEX_to_HSV("#ff0000");

pleasejs/please.d.ts

@@ -0,0 +1,121 @@
+// Type definitions for PleaseJS
+// Project: http://www.checkman.io/please/
+// Definitions by: Toshiya Nakakura <https://github.com/nakakura>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+declare var Please: PleaseJS.Please;
+
+declare module PleaseJS{
+    export interface Please{
+        /***
+         * generate and return a random hex string
+         * @param {MakeColorOption} options
+         * @returns {Array}
+         */
+        make_color(options?: MakeColorOption): Array<string>;
+        make_color(options?: MakeColorOption): Array<RGB>;
+        make_color(options?: MakeColorOption): Array<HSV>;
+
+        /***
+         * make a color scheme
+         * @param {MakeSchemeOption} options
+         * @returns {Array}
+         */
+        make_scheme(base_color: HSV, options?: MakeSchemeOption): Array<string>;
+        make_scheme(base_color: HSV, options?: MakeSchemeOption): Array<RGB>;
+        make_scheme(base_color: HSV, options?: MakeSchemeOption): Array<HSV>;
+
+        /***
+         * convert color name into hex string
+         * @param {string} name
+         * @returns {string}
+         */
+        NAME_to_HEX(name: string): string;
+
+        /***
+         * convert color name into RGB
+         * @param {string} name
+         * @returns {RGB}
+         */
+        NAME_to_RGB(name: string): RGB;
+
+        /***
+         * convert color name into RGB
+         * @param {string} name
+         * @returns {HSV}
+         */
+        NAME_to_HSV(name: string): HSV;
+
+        /***
+         * convert HEX into RGB
+         * @param {string} hex
+         * @returns {RGB}
+         */
+        HEX_to_RGB(hex: string): RGB;
+
+        /***
+         * convert RGB into HEX
+         * @param {RGB} rgb
+         * @returns {string}
+         */
+        RGB_to_HEX(rgb: RGB): string;
+
+        /***
+         * convert HSV into RGB
+         * @param {HSV} hsv
+         * @returns {RGB}
+         */
+        HSV_to_RGB(hsv: HSV): RGB;
+
+        /***
+         * convert RGB into HSV
+         * @param {RGB} rgb
+         * @returns {HSV}
+         */
+        RGB_to_HSV(rgb: RGB): HSV;
+
+        /***
+         * convert HSV into HEX
+         * @param {HSV} hsv
+         * @returns {string}
+         */
+        HSV_to_HEX(hsv: HSV): string;
+
+        /***
+         * convert HEX into HSV
+         * @param {string} hex
+         * @returns {HSV}
+         */
+        HEX_to_HSV(hex: string): HSV;
+    }
+
+    export interface MakeColorOption{
+        hue?: number;
+        saturation?: number;
+        value?: number;
+        base_color?: string;
+        greyscale?: boolean;
+        grayscale?: boolean;
+        golden?: boolean;
+        full_random?: boolean;
+        colors_returned?: number;
+        format?: string;
+    }
+
+    export interface MakeSchemeOption{
+        scheme_type: string;
+        format: string;
+    }
+
+    export interface RGB{
+        r: number;
+        g: number;
+        b: number;
+    }
+
+    export interface HSV{
+        h: number;
+        s: number;
+        v: number;
+    }
+}