vue3獲取ref實(shí)例結(jié)合ts的InstanceType問(wèn)題

更新時(shí)間：2023年03月06日 09:38:48 作者：未成年夢(mèng)想

這篇文章主要介紹了vue3獲取ref實(shí)例結(jié)合ts的InstanceType問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

為 props 標(biāo)注類型
非 <script setup>
為 emits 標(biāo)注類型
為 ref() 標(biāo)注類型
為 reactive() 標(biāo)注類型
為 computed() 標(biāo)注類型
為事件處理函數(shù)標(biāo)注類型
為 provide / inject 標(biāo)注類型
為 dom 模板引用標(biāo)注類型
為組件模板引用標(biāo)注類型

總結(jié)

vue3獲取ref實(shí)例結(jié)合ts的InstanceType

有時(shí)候我們模板引用，但是在使用的時(shí)候，ts提示卻不行，沒(méi)有提示組件通過(guò)defineExpose暴露的方法名稱，雖然這不是很影響，但是可以解決還是可以解決下~

<!-- MyModal.vue -->
<script setup lang="ts">
import { ref } from 'vue'

const sayHello = () => (console.log('我會(huì)說(shuō)hello'))

defineExpose({
? sayHello
})
</script>

然后我們?cè)诟讣?jí)使用，輸入完成MyModalRef.value會(huì)發(fā)現(xiàn)沒(méi)有sayHello這個(gè)函數(shù)提示，所以這個(gè)時(shí)候我們就需要使用InstanceType 工具類型來(lái)獲取其實(shí)例類型

<!-- App.vue -->
<script setup lang="ts">
import MyModal from './MyModal.vue'
const MyModalRef = ref()

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

使用InstanceType 工具類型獲取其實(shí)例類型：

<!-- MyModal.vue -->
<script setup lang="ts">
import { ref } from 'vue'

const sayHello = () => (console.log('我會(huì)說(shuō)hello'))

defineExpose({
? open
})
</script>

父級(jí)使用

<!-- App.vue -->
<script setup lang="ts">
import MyModal from './MyModal.vue'

const MyModalRef = ref<InstanceType<typeof MyModal> | null>(null)

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

貌似依舊沒(méi)有提示使用InstanceType在提示的時(shí)候，然后輸入錯(cuò)誤內(nèi)容也沒(méi)有在編譯前進(jìn)行報(bào)錯(cuò)…，不過(guò)vue官方這樣子說(shuō)了，那就聽(tīng)他的吧(其實(shí)我一般不用，不過(guò)也學(xué)到了)

@vue官方API為組件模板引用標(biāo)注類型

如何為vue3組件標(biāo)注TS類型

要說(shuō)今年最熱門的前端技術(shù)，Vue3 和 TS 絕對(duì)榜上有名了。據(jù)了解，已經(jīng)有很多公司在使用 Vue3 + TS + Vite 開(kāi)發(fā)新項(xiàng)目了。給大家分享一下如何在 Vue3 組件中結(jié)合 Composition-Api 使用 TS 類型。

為 props 標(biāo)注類型

使用 <script setup>

當(dāng)使用 <script setup> 時(shí)，defineProps() 宏函數(shù)支持從它的參數(shù)中推到類型：

<script setup lang="ts">
const props = defineProps({
? foo: { type: String, required: true },
? bar: Number
})
?
props.foo // string
props.bar // number / undefined
</script>

這被稱為運(yùn)行時(shí)聲明，因?yàn)閭鬟f給 defineProps() 的參數(shù)會(huì)作為運(yùn)行時(shí)的 props 選項(xiàng)使用。

第二種方式，通過(guò)泛型參數(shù)來(lái)定義 props 的類型，這種方式更加直接：

<script setup lang="ts">
const props = defineProps<{
? foo: string
? bar?: number
}>()
</script>
?
/* or
<sctipt setup lang="ts">
interface Props {
? foo: string
? bar?: number
}
const props = defineProps<Props>()
</script>
*/

這被稱為基于類型的聲明，編譯器會(huì)盡可能地嘗試根據(jù)類型參數(shù)推導(dǎo)出等價(jià)的運(yùn)行時(shí)選項(xiàng)。這種方式的不足之處在于，失去了定義 props 默認(rèn)值的能力。為了解決這個(gè)問(wèn)題，我們可以使用 withDefaults 編譯器：

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

上面代碼會(huì)被編譯為等價(jià)的運(yùn)行時(shí) props 的 default 選項(xiàng)。

非 <script setup>

如果沒(méi)有使用 <script setup>，那么為了開(kāi)啟 props 的類型推導(dǎo)，必須使用 defineComponent() 。傳入 setup() 的 props 對(duì)象類型是從 props 選項(xiàng)中推導(dǎo)而來(lái)。

import { defineComponent } from 'vue'
?
export default defineComponent({
? props: {
? ? message: String
? },
? setup(props){
? ? props.message // 類型：string
? }
})

為 emits 標(biāo)注類型

使用 <script setup>

在 <script setup> 中，emit 函數(shù)的類型標(biāo)注也可以使用運(yùn)行時(shí)聲明或者基于類型的聲明：

<script setup lang="ts">
// 運(yùn)行時(shí)
const emit = defineEmits(['change', 'update'])
?
//基于類型
const emit = defineEmits<{
? (e: 'change', id: number): void
? (e: 'update', value: string): void
}>()
</script>

我們可以看到，基于類型聲明可以使我們對(duì)所觸發(fā)事件的類型進(jìn)行更細(xì)粒度的控制。

非<script setup>

若沒(méi)有使用 <script setup>，defineComponent() 也可以根據(jù) emits 選項(xiàng)推導(dǎo)暴露在 setup 上下文中的 emit 函數(shù)的類型：

import { defineComponent } from 'vue'
?
export default definComponent({
? emits: ['change'],
? setup(props, { emit }) {
? ? emit('change') //類型檢查 / 自動(dòng)補(bǔ)全
? }
})

為 ref() 標(biāo)注類型

默認(rèn)推導(dǎo)類型

ref 會(huì)根據(jù)初始化時(shí)的值自動(dòng)推導(dǎo)其類型：

import { ref } from 'vue'
?
// 推導(dǎo)出的類型：Ref<number>
?
const year = ref(2022)
?
// TS Error: Type 'string' is not assignable to type 'number'.
year.value = '2022'

通過(guò)接口指定類型

有時(shí)我們可能想為 ref 內(nèi)的值指定一個(gè)更復(fù)雜的類型，可以通過(guò)使用 Ref 這個(gè)接口：

import { ref } from 'vue'
import type { Ref } from 'vue'
?
const year: Ref<string | number> = ref(2022)
year.value = 2022 //成功

通過(guò)泛型指定類型

或者，在調(diào)用 ref() 時(shí)傳入一個(gè)泛型參數(shù)，來(lái)覆蓋默認(rèn)的推導(dǎo)行為：

// 得到的類型：Ref<string | number>
const year = ref<string | number>('2022')
year.value = 2022 //成功

如果你指定了一個(gè)泛型參數(shù)但沒(méi)有給出初始值，那么最后得到的就將是一個(gè)包含 undefined 的聯(lián)合類型：

// 推導(dǎo)得到的類型：Ref<number | undefined>
const n = ref<number>()

為 reactive() 標(biāo)注類型

默認(rèn)推導(dǎo)類型

reactive() 也會(huì)隱式地從它的參數(shù)中推導(dǎo)類型：

import { reactive } from 'vue'
?
//推導(dǎo)得到的類型：{ title: string }
const book = reactive({ title: 'Vue 3 指引'})

通過(guò)接口指定類型

要顯示地指定一個(gè) reactive 變量的類型，我們可以使用接口：

import { reactive } from 'vue'
?
interface Book {
? title: string
? year?: number
}
?
const book: Book = reactive({ title: 'Vue 3 指引' })

為 computed() 標(biāo)注類型

默認(rèn)推導(dǎo)類型

computed() 會(huì)自動(dòng)從其計(jì)算函數(shù)地返回值上推導(dǎo)出類型：

import { ref, computed } from 'vue'
const count = ref(0)
?
// 推導(dǎo)得到的類型：ComputedRef<number>
const double = computed(() => count.value * 2)
?
// TS Error: Property 'split' does not exist on type 'number'
const result = double.value.split('')

通過(guò)泛型指定類型

const double = component<number>(() => {
? // 若返回值不是 number 類型則會(huì)報(bào)錯(cuò)
})

為事件處理函數(shù)標(biāo)注類型

在處理原生 DOM事件時(shí)，應(yīng)該給事件處理函數(shù)的參數(shù)正確地標(biāo)注類型，如：

<script srtup lang="ts">
function handleChange(event) {
? // `event` 隱式地標(biāo)注為 `any`類型
? console.log(event.target.value)
}
</script>
?
<template>
? <input type="text" @change="handleChange" />
</template>

沒(méi)有類型標(biāo)注時(shí)，這個(gè) event 參數(shù)會(huì)隱式地標(biāo)注為 any 類型。這也會(huì)在 tsconfig.json 中配置了 "strict": true 或 "noImplicitAny": true 時(shí)報(bào)出一個(gè) TS 錯(cuò)誤。因此，建議顯式地為事件處理函數(shù)地參數(shù)標(biāo)注類型。此外，你可能需要顯式地強(qiáng)制轉(zhuǎn)換 event 上地屬性：

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

為 provide / inject 標(biāo)注類型

provide 和 inject 通常會(huì)在不同的組件中運(yùn)行。要正確地為注入的值標(biāo)記類型，Vue提供了一個(gè) Injectionkey 接口，它是一個(gè)繼承自 Symbol 的泛型類型，可以用來(lái)在提供者和消費(fèi)者之間同步注入值的類型：

import { provide, inject } from 'vue'
import type { Injectiokey } from 'vue'
?
const key = Symbol() as Injectionkey<string>
provide(key,'foo') // 若提供的是非字符串值會(huì)導(dǎo)致錯(cuò)誤
?
const foo = inject(key) // foo 的類型： string | undefined

建議將注入 key的類型放在一個(gè)單獨(dú)的文件中，這樣它就可以被多個(gè)組件導(dǎo)入。

當(dāng)使用字符串注入 key 時(shí)，注入值的類型是 unknown，需要通過(guò)泛型參數(shù)顯示聲明：

const foo = inject<string>('key') // 類型：string | undefined

注意注入的值仍然可以是 undefined，因?yàn)闊o(wú)法保證提供者一定會(huì)在運(yùn)行時(shí) provide 這個(gè)值。當(dāng)提供了一個(gè)默認(rèn)值后，這個(gè) undefined 類型就可以被移除：

const foo = inject<string>('foo', 'bar') // 類型：string

如果你確定該值始終被提供，則還可以強(qiáng)制轉(zhuǎn)換該值：

const foo = inject('foo') as string

為 dom 模板引用標(biāo)注類型

模板 ref 需要通過(guò)一個(gè)顯式指定的泛型參數(shù)和一個(gè)初始值 null 來(lái)創(chuàng)建：

<script setup lang="ts">
import { ref, onMounted } from 'vue'
const el = ref<HTMLInputElement | null>(null)
?
onMounted(() => {
? el.value?.focus()
})
</script>
?
<template>
? <input ref="el" />
</template>

注意為了嚴(yán)格的類型安全，有必要在訪問(wèn) el.value 時(shí)使用可選鏈或類型守衛(wèi)。這是因?yàn)橹钡浇M件被掛載前，這個(gè) ref 的值都是初始的 null，并且 v-if 將引用的元素卸載時(shí)也會(huì)被設(shè)置為 null。

為組件模板引用標(biāo)注類型

有時(shí)，我們需要為一個(gè)子組件添加一個(gè)模板 ref，以便調(diào)用它公開(kāi)的方法。比如，我們有一個(gè) MyModal 子組件，它有一個(gè)打開(kāi)模態(tài)框的方法：

<script setup lang="ts">
import { ref } from 'vue'
?
const isContentShown = ref(false)
const open = () => (isContentShow.value = true)
?
defineExpose({
? open
})
</script>

為了獲取 MyModal 的類型，我們首先需要通過(guò) typeof 得到其類型，再使用 TypeScript 內(nèi)置的 InstanceType 工具類型來(lái)獲取其實(shí)例類型：

<script>
import MyModal from './MyModal.vue'
?
const modal = ref<InstanceType<typeof MyModal > | null>(null)
const openModal = () => {
? modal.value?.open()
}
</script>