使用TS进行Vue-Router的Meta类型扩展

最新推荐文章于 2025-04-23 16:24:56 发布

冲浪的鹏多多

最新推荐文章于 2025-04-23 16:24:56 发布

阅读量918

点赞数 1

分类专栏： Vue 文章标签： vue.js 前端 javascript

本文链接：https://blog.youkuaiyun.com/pdd11997110103/article/details/134292104

版权

Vue 专栏收录该内容

36 篇文章

订阅专栏

本文讲述了在Vue-Router中，如何解决TypeScript对Meta对象字段识别为unknown类型的问题。通过在项目中扩展RouteMeta接口并正确配置tsconfig.json，可以消除编译时的错误，提供代码提示。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、前言

使用Vue-Router时，会将一些字段信息附加到路由的Meta对象里面，比如图标icon，标题，权限等，如下：

{
  path: '/billboard/board/:boardId',
  name: 'billboardBoard',
  props: true,
  component: () => import('@/views/billboard/board.vue'),
  meta: {
    title: 'message.router.billboard',
    isHide: true,
    isKeepAlive: false,
    isAffix: false,
    isIframe: false,
    icon: 'iconfont icon-board'
  }
}

但是在使用的过程中，TS会认为这些字段是unknown类型，从而导致赋值或者使用的时候会报错：

router.beforeEach((to) => {
	document.title = to.meta.title || '默认标题'
})

如图：

2、解决

为了避免报错和标红（虽然不影响程序运行），我们可以通过扩展RouteMeta接口，声明Meta的字段，这样在使用过程中不仅不会报错标红，还会有代码提示，方法如下：

在根目录或者types目录下，新建一个router-meta.d.ts文件，文件内容如下：

/**
 * @description 扩展ruoter-meta的类型 此处必须要export {} 不然找不到类型
 */
declare module 'vue-router' {
	interface RouteMeta {
		permission?: Array<string>
		title?: string
		icon?: string
		affix?: boolean
		hidden?: boolean
		keepAlive?: boolean
	}
}

export {}

在根目录tsconfig.json的include选项中，能够包含到这个文件即可。

{
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue", "types/**/*.d.ts", "types/**/*.ts"],
  "exclude": ["node_modules/**", "dist", "**/*.js"]
}