vue3获取ref实例结合ts的InstanceType问题怎么解决

vue3获取ref实例结合ts的InstanceType

有时候我们模板引用，但是在使用的时候，ts提示却不行，没有提示组件通过defineExpose暴露的方法名称，虽然这不是很影响，但是可以解决还是可以解决下~

import { ref } from 'vue'

const sayHello = () => (console.log('我会说hello'))

defineExpose({
  sayHello
})

然后我们在父级使用，输入完成MyModalRef.value会发现没有sayHello这个函数提示，所以这个时候我们就需要使用InstanceType 工具类型来获取其实例类型

import MyModal from './MyModal.vue'
const MyModalRef = ref()

const handleOperation = () => {
  MyModalRef.value.sayHello
}

使用InstanceType 工具类型获取其实例类型：

import { ref } from 'vue'

const sayHello = () => (console.log('我会说hello'))

defineExpose({
  open
})

父级使用

import MyModal from './MyModal.vue'

const MyModalRef = ref | null>(null)

const handleOperation = () => {
  MyModalRef.value?.sayHello()
}

貌似依旧没有提示使用InstanceType在提示的时候，然后输入错误内容也没有在编译前进行报错…，不过vue官方这样子说了，那就听他的吧(其实我一般不用，不过也学到了)

@vue官方API为组件模板引用标注类型

如何为vue3组件标注TS类型

要说今年最热门的前端技术，Vue3 和 TS 绝对榜上有名了。据了解，已经有很多公司在使用 Vue3 + TS + Vite 开发新项目了。给大家分享一下如何在 Vue3 组件中结合 Composition-Api 使用 TS 类型。

为 props 标注类型

使用

这被称为 运行时声明，因为传递给 defineProps() 的参数会作为运行时的 props 选项使用。

第二种方式，通过泛型参数来定义 props 的类型，这种方式更加直接：

const props = defineProps<{
  foo: string
  bar?: number
}>()

 
/* or

interface Props {
  foo: string
  bar?: number
}
const props = defineProps()

*/

这被称为 基于类型的声明，编译器会尽可能地尝试根据类型参数推导出等价的运行时选项。这种方式的不足之处在于，失去了定义 props 默认值的能力。为了解决这个问题，我们可以使用 withDefaults 编译器：

interface Props {
  msg?: string
  labels?: string[]
}
 
const props = withDefaults(defineProps(), {
  msg: 'hello',
  label: () => ['one', 'two']
})

上面代码会被编译为等价的运行时 props 的 default 选项。

非

我们可以看到，基于类型声明 可以使我们对所触发事件的类型进行更细粒度的控制。

非  

没有类型标注时，这个 event 参数会隐式地标注为 any 类型。这也会在 tsconfig.json 中配置了 "strict": true 或 "noImplicitAny": true 时报出一个 TS 错误。因此，建议显式地为事件处理函数地参数标注类型。此外，你可能需要显式地强制转换 event 上地属性：

function handleChange(event: Event) {
  console.log((event.target as HTMLInputElement).value)
}

为 provide / inject 标注类型

provide 和 inject 通常会在不同的组件中运行。要正确地为注入的值标记类型，Vue提供了一个 Injectionkey 接口，它是一个继承自 Symbol 的泛型类型，可以用来在提供者和消费者之间同步注入值的类型：

import { provide, inject } from 'vue'
import type { Injectiokey } from 'vue'
 
const key = Symbol() as Injectionkey
provide(key,'foo') // 若提供的是非字符串值会导致错误
 
const foo = inject(key) // foo 的类型： string | undefined

建议将注入 key的类型放在一个单独的文件中，这样它就可以被多个组件导入。

当使用字符串注入 key 时，注入值的类型是 unknown，需要通过泛型参数显示声明：

const foo = inject('key') // 类型：string | undefined

注意注入的值仍然可以是 undefined，因为无法保证提供者一定会在运行时 provide 这个值。当提供了一个默认值后，这个 undefined 类型就可以被移除：

const foo = inject('foo', 'bar') // 类型：string

如果你确定该值始终被提供，则还可以强制转换该值：

const foo = inject('foo') as string

为 dom 模板引用标注类型

模板 ref 需要通过一个显式指定的泛型参数和一个初始值 null 来创建：

import { ref, onMounted } from 'vue'
const el = ref(null)
 
onMounted(() => {
  el.value?.focus()
})

 

注意为了严格的类型安全，有必要在访问 el.value 时使用可选链或类型守卫。这是因为直到组件被挂载前，这个 ref 的值都是初始的 null，并且 v-if 将引用的元素卸载时也会被设置为 null。

为组件模板引用标注类型

有时，我们需要为一个子组件添加一个模板 ref，以便调用它公开的方法。比如，我们有一个 MyModal 子组件，它有一个打开模态框的方法：

import { ref } from 'vue'
 
const isContentShown = ref(false)
const open = () => (isContentShow.value = true)
 
defineExpose({
  open
})

为了获取 MyModal 的类型，我们首先需要通过 typeof 得到其类型，再使用 TypeScript 内置的 InstanceType 工具类型来获取其实例类型：