uni-app使用TypeScript uni-app TS项目如何创建

陌雪姑娘_2309

陌雪姑娘_2309

2026-03-23

741人浏览

原创

uni-app cli 创建 ts 项目需手动确认“yes”启用typescript,检查tsconfig.json和main.ts;app.vue须用defineapp/definepage泛型,pages.json需全局声明类型;getcurrentpages()须类型断言;必须安装并配置@dclo‍udio/types以支持uni全局api类型。

uni-app使用typescript uni-app ts项目如何创建

uni-app CLI 创建 TS 项目时选错模板会直接生成 JS 项目

uni-app 官方 CLI(npm create uni-app@latest)默认不强制启用 TypeScript,即使你选了“TypeScript”选项,也可能因模板版本或交互逻辑问题,最终生成的是 main.js 而非 main.ts。

实操建议:

  • 执行 npm create uni-app@latest 后,**必须手动确认最后一步是否显示 Use TypeScript? » Yes 并回车确认**,不能跳过或按默认回车(有些终端会默认选 No)
  • 创建完成后立即检查根目录下是否存在 tsconfig.json 和 src/main.ts;若只有 main.js,说明失败,需删掉重来
  • 避免使用旧版全局安装的 @vue/cli-plugin-uni 或第三方脚手架,它们对 TS 支持不稳定,只认官方 create uni-app

TS 项目里 App.vue 和 pages.json 的类型声明容易漏配

uni-app 的 App.vue 是入口组件,但默认模板不会自动加 defineComponent 和类型标注;pages.json 虽是 JSON 文件,但实际被 uni-app 编译器读取为 JS 对象,TS 不校验它——但你在 JS/TS 里 import 它时,没类型提示会埋坑。

实操建议:

  • App.vue 的 <script setup lang="ts"></script> 区域,务必用 definePage(H5/小程序平台)或 defineApp(App 端)配合泛型,例如:defineApp<appoptions>({})</appoptions>,否则生命周期参数无类型
  • 在 src/types/global.d.ts 中手动声明 declare module '@/pages.json',再给它导出一个 interface,否则 import pages from '@/pages.json' 会报 Cannot find module
  • 别依赖 IDE 自动推导 pages.json 结构,它的字段(如 subNVue、usingComponents)有平台差异,硬编码类型比 any 更安全

uni-app 的 getCurrentPages() 返回值在 TS 下默认是 any[]

这个函数在 JS 里很常用,但在 TS 项目中,如果不显式标注,返回的页面实例数组没有任何类型信息,调用 page.$vm?.dataRef 或自定义属性时会报错或失去智能提示。

实操建议:

  • 不要直接写 const pages = getCurrentPages(),而要写成:const pages = getCurrentPages() as Page.PageInstance[]
  • 注意:不同平台返回的页面类型不同——H5 是 Page.PageInstance,微信小程序是 WechatMiniprogram.Page.Instance,App 端是 UniApp.Page;跨平台项目建议封装一层类型守卫函数
  • 如果用了 uni.navigateTo 传参,记得在目标页面的 onLoad 里用 options 参数接收,它的类型是 Record<string string></string>,不是 any,别漏了类型断言

TS 编译报错 Cannot find name 'uni' 或 Property 'reLaunch' does not exist on type 'typeof uni'

这是最常卡住人的错误。uni-app 的全局 API(uni.navigateTo、uni.getSystemInfoSync 等)类型定义不在 types 目录下,也不随 uni-app npm 包自动注入,需要手动配置。

实操建议:

  • 确保 tsconfig.json 的 compilerOptions.types 包含 "@dcloudio/types"(不是 uni-app 或 miniprogram-api-typings)
  • 检查是否安装了 @dcloudio/types:运行 npm install -D @dcloudio/types,且版本要与 uni-app CLI 版本对齐(v3.99+ 对应 @dcloudio/types@3.99.x)
  • 如果用了 HBuilderX,它自带类型库,但 CLI 项目必须靠 @dcloudio/types,别指望编辑器自动补全能代替配置
TS 类型支持不是开箱即用的,每个平台的 API 差异、全局变量注入时机、以及 pages.json 这类非标准模块的处理,都得手动兜底。漏一个 as 或少一行 types 配置,就可能让整个项目的类型检查形同虚设。
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2423

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5243

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6290

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

5858

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

843

5

C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3089

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2288

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1178

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习