first commit

wmsjstpda/types/api.d.ts

@@ -0,0 +1,18 @@
+/** 所有 api 接口的响应数据都应该准守该格式 */
+interface ApiResponseData<T> {
+  isSucc: boolean
+  code: number
+  data: T
+  message: string
+}
+
+/** 所有 api 接口的响应数据都应该准守该格式,数组类型 */
+interface ApiResponseDataArray<T> {
+[x: string]: number
+  isSucc: boolean
+  code: number
+  data: Array<T>
+  message: string
+  totalRecord: number
+  otherInfo: any
+}

wmsjstpda/types/env.d.ts

@@ -0,0 +1,10 @@
+/** 声明 vite 环境变量的类型（如果未声明则默认是 any） */
+declare interface ImportMetaEnv {
+  readonly VITE_BASE_API: string
+  readonly VITE_ROUTER_HISTORY: "hash" | "html5"
+  readonly VITE_PUBLIC_PATH: string
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv
+}

wmsjstpda/types/global-components.d.ts

@@ -0,0 +1,10 @@
+import SvgIcon from "@/components/SvgIcon/index.vue"
+
+/** 由 app.component 全局注册的组件需要在这里声明 TS 类型才能获得 Volar 插件提供的类型提示） */
+declare module "vue" {
+  export interface GlobalComponents {
+    SvgIcon: typeof SvgIcon
+  }
+}
+
+export {}

wmsjstpda/types/shims-vue.d.ts

@@ -0,0 +1,4 @@
+declare module "*.scss" {
+  const scss: Record<string, string>
+  export default scss
+}

wmsjstpda/types/vue-router.d.ts

@@ -0,0 +1,52 @@
+import "vue-router"
+
+declare module "vue-router" {
+  interface RouteMeta {
+    /**
+     * 设置该路由在侧边栏和面包屑中展示的名字
+     */
+    title?: string
+    /**
+     * 设置该路由的图标，记得将 svg 导入 @/icons/svg
+     */
+    svgIcon?: string
+    /**
+     * 设置该路由的图标，直接使用 Element Plus 的 Icon（与 svgIcon 同时设置时，svgIcon 将优先生效）
+     */
+    elIcon?: string
+    /**
+     * 默认 false，设置 true 的时候该路由不会在侧边栏出现
+     */
+    hidden?: boolean
+    /**
+     * 设置该路由进入的权限，支持多个权限叠加
+     */
+    roles?: string[]
+    /**
+     * 默认 true，如果设置为 false，则不会在面包屑中显示
+     */
+    breadcrumb?: boolean
+    /**
+     * 默认 false，如果设置为 true，它则会固定在 tags-view 中
+     */
+    affix?: boolean
+    /**
+     * 当一个路由下面的 children 声明的路由大于 1 个时，自动会变成嵌套的模式，
+     * 只有一个时，会将那个子路由当做根路由显示在侧边栏，
+     * 若想不管路由下面的 children 声明的个数都显示你的根路由，
+     * 可以设置 alwaysShow: true，这样就会忽略之前定义的规则，一直显示根路由
+     */
+    alwaysShow?: boolean
+    /**
+     * 示例: activeMenu: "/xxx/xxx"，
+     * 当设置了该属性进入路由时，则会高亮 activeMenu 属性对应的侧边栏。
+     * 该属性适合使用在有 hidden: true 属性的路由上
+     */
+    activeMenu?: string
+    /**
+     * 是否缓存该路由页面
+     * 默认为 false，为 true 时代表需要缓存，此时该路由和该页面都需要设置一致的 Name
+     */
+    keepAlive?: boolean
+  }
+}