TypeScript
我们通过 @dcloudio/types 和 @uni-helper/uni-types 提供了完整类型
类型检查
出于性能原因,开发与构建时都不检查类型。用内置的 vue-tsc 单独检查:
pnpm typecheck
类型声明
模板在 tsconfig.json 的 compilerOptions.types 里启用以下类型:
| 类型 | 来源 |
|---|---|
vite/client | Vite 客户端 API |
@dcloudio/types | uni API |
@mini-types/alipay | my API |
miniprogram-api-typings | wx API |
@uni-helper/uni-types | uni-app、uni-cloud、uni-ui 组件 |
@uni-helper/vite-plugin-uni-pages/client | definePage 与 virtual:uni-pages |
@uni-helper/vite-plugin-uni-middleware/client | virtual:uni-middleware |
vitest-environment-uniapp/types | 测试环境 |
自动生成的类型
开发和构建命令会生成以下声明文件:
| 文件 | 来源 | 用途 |
|---|---|---|
src/uni-pages.d.ts | @uni-helper/vite-plugin-uni-pages | 页面路径与 definePage 的类型 |
src/uni-layouts.d.ts | @uni-helper/vite-plugin-uni-layouts | 布局名与 useUhUniLayoutRef 的类型 |
这两个文件由插件生成,不要手改。
页面实例类型
src/shims.d.ts 把 App.AppInstance 与 Page.PageInstance 挂到 Vue 的 ComponentCustomOptions,这样 this 在选项式 API 里能拿到 uni-app 的页面生命周期类型。
src/shims.d.ts
export {}
declare module 'vue' {
type Hooks = App.AppInstance & Page.PageInstance
interface ComponentCustomOptions extends Hooks {}
}