# TypeScript 支持

uni-app 支持使用 ts 开发,可参考 Vue.js TypeScript 支持 (opens new window) 说明。

类型定义文件由 @dcloudio/types 模块提供,安装后请注意配置 tsconfig.json 文件中的 compilerOptions > types 部分,如需其他小程序平台类型定义也可以安装,如:miniprogram-api-typings、mini-types。对于缺少或者错误的类型定义,可以自行在本地新增或修改并同时报告给官方请求更新。

# 开发方式

  • HBuilderX创建的项目

在 vue 或 nvue 页面的 script 节点,添加属性 lang="ts"

<script lang="ts">
// 这里编写ts代码
</script>
  • cli创建的项目

需要在创建项目时就指定ts,具体请另行参考文档 (opens new window)

# 修改 Typescript 配置

在根目录创建 tsconfig.json 文件,并进行个性化配置,推荐配置如下:

// tsconfig.json
{
  "compilerOptions": {
    // 与 Vue 的浏览器支持保持一致
    "target": "es5",
    // 这可以对 `this` 上的数据 property 进行更严格的推断
    "strict": true,
    // 如果使用 webpack 2+ 或 rollup,可以利用 tree-shake:
    "module": "es2015",
    "moduleResolution": "node",
    "types": ["@dcloudio/types"]
  }
}

个性化配置是可选的,没有tsconfig.json时会自动使用默认配置运行。

# TypeScript 支持兼容性说明

  • uni-app 的 vue2 模式:nvue 文件中不支持编写 ts。vue 文件中可以使用 ts,但 ts 版本根据项目类型有区别。HBuilderX 创建的项目使用 ts 3.7.5,cli 创建的项目使用 ts 3.0.0。
  • uni-app 的 vue3 模式:vue 文件及 nvue 文件均支持最新版 ts。

# 注意事项

声明 lang="ts" 后,该 vue/nvue 文件 import 进来的所有 vue 组件,均需要使用 ts 编写。

示例代码

改造 uni-badge.vue

<script lang="ts">
    // 仅展示需要修改的核心代码,完整代码请参考原来的组件。
	import Vue from 'vue';
	export default Vue.extend({
		props: {
			type: {
				type: String,
				default: 'default'
			},
			inverted: {
				type: Boolean,
				default: false
			},
			text: {
				type: [String, Number],
				default: ''
			},
			size: {
				type: String,
				default: 'normal'
			}
		},
		computed: {
			setClass(): string {
				const classList: string[] = ['uni-badge-' + this.type, 'uni-badge-size-' + this.size];
				if (this.inverted === true) {
					classList.push('uni-badge-inverted')
				}
				return classList.join(" ")
			}
		},
		methods: {
			onClick() {
				this.$emit('click')
			}
		}
	})
</script>

在 index.vue 中引用 uni-badge 组件

<script lang="ts">
    import Vue from 'vue';
	import uniBadge from '../../components/uni-badge.vue';
	export default Vue.extend({
		data() {
			return {
				title: 'Hello'
			}
		},
		components:{
			uniBadge
		}
	});
</script>