讲师中心 微信公众号

工具推荐

视频效率加速
updream

一键生成高质量推广成片

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

立刻MV
立刻MV

低成本歌曲 MV、视频生成

Vue 3 Emits 怎么在 TypeScript 中规范联合事件与携带参数类型

梦雪君_9504

梦雪君_9504

发布时间:2026-11-14 08:34:03

|

874人浏览过

|

来源于php中文网

原创

TypeScript 中规范 Vue 3 emits 的核心是用结构化类型精确约束事件名及参数:推荐调用签名语法(多态函数重载)或 Vue 3.3+ 对象字面量语法,支持参数类型、顺序、可选性校验;应抽离接口复用,避免字符串数组或 any 等弱类型写法。

vue 3 emits 怎么在 typescript 中规范联合事件与携带参数类型

在 TypeScript 中规范 Vue 3 的 emits,关键在于用类型系统精确描述“哪些事件能发、每个事件带几个参数、各参数是什么类型、哪些可选”。联合事件(比如 'success' | 'error' | 'loading')和携带参数的组合,不能靠字符串数组应付,必须用结构化类型约束。

用调用签名语法定义联合事件 + 多态参数

这是最严谨、IDE 支持最好的方式,适合参数结构差异大的场景:

  • 每个事件单独写一条函数签名,事件名用字面量类型(e: 'success'),后续参数即 emit 实际传入的负载
  • 支持可选参数(message?: string)、联合类型(data: string | number)、甚至不同事件参数完全不相关
  • 调用时 TypeScript 会自动匹配对应签名,错传、少传、类型不符都会报错

示例:

const emit = defineEmits<{
  (e: 'success', data: { id: number; name: string }): void;
  (e: 'error', code: number, message: string): void;
  (e: 'loading', isActive: boolean): void;
  (e: 'update:modelValue', value: string | null): void;
}>();

触发时:

立即学习“前端免费学习笔记(深入)”;

  • emit('success', { id: 1, name: 'Vue' }) ✅
  • emit('error', 404, 'Not found') ✅
  • emit('error', 'oops') ❌ 类型错误:第一个参数应为 number

用对象字面量语法定义带命名参数的联合事件

Vue 3.3+ 推荐写法,更简洁,对参数顺序和元组结构校验更严格:

typescript-advanced-types
typescript-advanced-types

精通 TypeScript 高级类型系统,包括泛型、条件类型、映射类型、模板字面量类型与工具类型,用于构建类型安全的应用。在实现复杂类型逻辑、创建可复用类型工具

下载
  • 键是事件名(支持 kebab-case,如 'item-click'),值是参数元组类型
  • 元组中可用 paramName: Type 命名(仅增强可读性,不参与类型检查)
  • 空参数写 [],单参数写 [value: string],多参数按顺序列

示例:

const emit = defineEmits<{
  'success': [{ id: number; name: string }];
  'error': [code: number, message: string];
  'cancel': [];
  'update:modelValue': [value: string];
}>();

注意:'error' 的两个参数顺序不可颠倒,emit('error', 'msg', 500) 会直接报错。

抽离接口复用复杂联合事件定义

当多个组件共用同一套事件契约(如表单、弹窗、列表操作),建议把类型定义成导出接口:

  • 统一维护、避免重复、便于团队对齐
  • 支持继承扩展(extends)、泛型参数(适配不同数据结构)
  • 配合 import('@types/my-components').FormEmits 在项目中跨模块引用

示例(定义在 types/events.ts):

export interface FormEmits {
  (e: 'submit', payload: FormData): void;
  (e: 'validate-fail', errors: Record<string, string[]>): void;
  (e: 'reset'): void;
}

// 组件中使用
const emit = defineEmits<FormEmits>();

避开常见陷阱

这些写法看似省事,实则放弃类型安全:

  • defineEmits(['submit', 'error']) → 完全无参数校验,拼错事件名也发现不了
  • defineEmits() → any 等于没写,失去所有提示和检查
  • 混用 kebab-case 和 camelCase 事件名 → 模板中 @item-click 和代码中 emit('itemClick') 不一致,易出错

推荐全项目统一用 kebab-case 命名事件(Vue 官方推荐),并在类型定义和实际调用中保持完全一致。

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

3003

2023.08.11

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

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

6583

2023.10.09

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

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

7430

2024.03.19

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

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

7338

2024.03.22

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

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

1043

2024.05.22

TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

332

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

540

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

411

2026.03.13

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 17.5万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn