Merge pull request #29 from Jasery/feat-ts-support

feat: 添加TypeScript 类型支持

gulpfile.js

@@ -51,6 +51,14 @@ const buildConfig = [
         babel: true,
         uglify: true,
         watch: true
+    },
+    {
+        name: 'types',
+        from: buildFrom + 'index.d.ts',
+        to: buildTo,
+        babel: false,
+        uglify: false,
+        watch: true
     }
 ]
 

package.json

@@ -4,6 +4,7 @@
     "description": "微信小程序 canvas-2d 绘图工具，支持按需引用，支持内容配置，支持功能扩展，适配各种机型，超轻量，超易用，无需学习，直接上手。",
     "main": "miniprogram_dist",
     "miniprogram": "miniprogram_dist",
+    "types": "miniprogram_dist/index.d.ts",
     "files": [
         "miniprogram_dist",
         "postinstall.js"

plugin/index.d.ts

@@ -0,0 +1,81 @@
+export class WxCanvas2d {
+    create(opts: {
+        query: string;
+        rootWidth?: number;
+        bgColor?: string;
+        component?: any;
+        radius?: number;
+    }) : Promise<void>;
+
+    draw(opts: { series: ISerie[] }) : Promise<void>;
+    clear(): void;
+
+    save(opts: {
+        x?: number;
+        y?: number;
+        width?: number;
+        height?: number;
+        destWidth?: number;
+        destHeight?: number;
+        modalOption?: {
+            title?: string;
+            content?: string;
+            success?: (res: { confirm: boolean, cancel: boolean }) => void;
+        };
+    }) : Promise<{ tempFilePath: string }>;
+
+    static use(plugin: IPlugin): void;
+}
+
+export interface ISerieType {
+    name: string;
+    handler: (config: Exclude<ISerie, 'type'>) => Promise<void>;
+}
+
+export interface IPlugin {
+    name: string;
+    handler: (opt: any) => void;
+}
+
+export interface ISerie {
+    type: ISerieType;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    bgColor?: string;
+    radius?: number;
+    lineStyle?: {
+        color?: string;
+        width?: number;
+        dash?: number[];
+    };
+    zIndex?: number;
+    reverse?: boolean;
+    r?: number;
+    blur?: number;
+    url?: string;
+    mode?: string;
+    text?: string;
+    fontSize?: number;
+    lineHeight?: number;
+    ellipsis?: number;
+    color?: string;
+    align?: string;
+    baseline?: string;
+    fontWeight?: string;
+    line?: { point: [number, number] }[];
+    'line.point'?: [number, number];
+    size?: number;
+}
+
+export const Arc: ISerieType;
+export const Blur: ISerieType;
+export const Image: ISerieType;
+export const Line: ISerieType;
+export const Qrcode: ISerieType;
+export const Rect: ISerieType;
+export const Text: ISerieType;
+
+export const Debugger: IPlugin;
+export const SaveToAlbum: IPlugin;