feat: typescript definitions from @vue-async/module-loader

affects: @vue-async/module-loader-typing

ts 类型定义, 使用在子模块中时

Author: aceHubert

packages/module-loader-typing/README.md

@@ -0,0 +1,4 @@
+# @vue-async/module-loader-type
+
+### TypeScript definitions for @vue-async/module-loader but using in the child modules
+

packages/module-loader-typing/index.d.ts

@@ -0,0 +1,22 @@
+import { Component as VueComponent, AsyncComponent } from 'vue';
+import { Framework, ModuleLoaderOptions } from './module';
+
+declare module 'vue/types/vue' {
+  interface Vue {
+    $moduleLoadManager: Framework & ModuleLoaderOptions;
+    $dynamicComponent: {
+      add: (
+        component: VueComponent | AsyncComponent | ({ component: VueComponent | AsyncComponent } & Record<string, any>),
+        position?: string,
+      ) => void;
+      remove: (name: string, position?: string) => void;
+    };
+    $eventBus: {
+      emit: (eventName: string, playload: any) => void;
+      on: (eventName: string, handler: (playload: any) => void) => void;
+      off: (eventName: string, handler: (playload: any) => void) => void;
+      clear: () => void;
+      getEvents: () => Record<string, any>;
+    };
+  }
+}

packages/module-loader-typing/module.d.ts

@@ -0,0 +1,10 @@
+import { Component as VueComponent, AsyncComponent } from 'vue';
+import { RouteConfig } from 'vue-router';
+
+export type ModuleLoaderOptions = Omit<Record<string, any>, 'layouts'>;
+
+export interface Framework {
+  layouts: Record<string, VueComponent | AsyncComponent>;
+  addRouters: (routes: RouteConfig[]) => void; // 可以被重写
+  addLayouts: (name: string, layout: VueComponent) => void; // 可以被重写
+}

packages/module-loader-typing/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@vue-async/module-loader-typing",
+  "version": "0.0.1",
+  "description": "TypeScript definitions for @vue-async/module-loader but using in the child modules",
+  "main": "",
+  "typings": "index.d.ts",
+  "keywords": [
+    "vue",
+    "vue-async",
+    "module-loader",
+    "async-module",
+    "async-loader",
+    "typescript",
+    "types"
+  ],
+  "scripts": {},
+  "author": "Hubert <yi.xiang@live.cn>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aceHubert/vue-async.git",
+    "directory": "packages/module-loader-type"
+  },
+  "bugs": {
+    "url": "https://github.com/aceHubert/vus-async/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "vue-router": "^3.1.6",
+    "vue": "^2.6.0"
+  }
+}