vue3獲取ref實例結(jié)合ts的InstanceType問題

更新時間：2023年03月06日 09:38:48 作者：未成年夢想

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

為 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實例結(jié)合ts的InstanceType

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

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

const sayHello = () => (console.log('我會說hello'))

defineExpose({
? sayHello
})
</script>

然后我們在父級使用，輸入完成MyModalRef.value會發(fā)現(xiàn)沒有sayHello這個函數(shù)提示，所以這個時候我們就需要使用InstanceType 工具類型來獲取其實例類型

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

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

使用InstanceType 工具類型獲取其實例類型：

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

const sayHello = () => (console.log('我會說hello'))

defineExpose({
? open
})
</script>

父級使用

<!-- 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>

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

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

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

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

為 props 標(biāo)注類型

使用 <script setup>

當(dāng)使用 <script setup> 時，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)行時聲明，因為傳遞給 defineProps() 的參數(shù)會作為運(yùn)行時的 props 選項使用。

第二種方式，通過泛型參數(shù)來定義 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>
*/

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

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

上面代碼會被編譯為等價的運(yùn)行時 props 的 default 選項。

非 <script setup>

如果沒有使用 <script setup>，那么為了開啟 props 的類型推導(dǎo)，必須使用 defineComponent() 。傳入 setup() 的 props 對象類型是從 props 選項中推導(dǎo)而來。

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)行時聲明或者基于類型的聲明：

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

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

非<script setup>

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

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

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

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

ref 會根據(jù)初始化時的值自動推導(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'

通過接口指定類型

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

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

通過泛型指定類型

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

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

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

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

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

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

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

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

通過接口指定類型

要顯示地指定一個 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() 會自動從其計算函數(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('')

通過泛型指定類型

const double = component<number>(() => {
? // 若返回值不是 number 類型則會報錯
})

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

在處理原生 DOM事件時，應(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>

沒有類型標(biāo)注時，這個 event 參數(shù)會隱式地標(biāo)注為 any 類型。這也會在 tsconfig.json 中配置了 "strict": true 或 "noImplicitAny": true 時報出一個 TS 錯誤。因此，建議顯式地為事件處理函數(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 通常會在不同的組件中運(yùn)行。要正確地為注入的值標(biāo)記類型，Vue提供了一個 Injectionkey 接口，它是一個繼承自 Symbol 的泛型類型，可以用來在提供者和消費者之間同步注入值的類型：

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

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

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

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

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

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

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

const foo = inject('foo') as string

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

模板 ref 需要通過一個顯式指定的泛型參數(shù)和一個初始值 null 來創(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)格的類型安全，有必要在訪問 el.value 時使用可選鏈或類型守衛(wèi)。這是因為直到組件被掛載前，這個 ref 的值都是初始的 null，并且 v-if 將引用的元素卸載時也會被設(shè)置為 null。

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

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

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

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

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