常用TS總結

唯之为之發表於2024-02-06

自己常用的 TS 寫法總結，應該會一直更新。可使用 TS線上編譯 校驗 TS 語法。

基本用法

普通

const num: number = 10
const isStop: boolean = false
const title: string = '常用TS總結'
const curName: null = null
const curType: undefined = undefined
const birthday: Date = new Date()

物件

// type
type LoginParams = {
  account: string
}
// interface
interface LoginParams {
  account: string
}

不確定是否有此屬性用 ?

interface Info {
  id: string
  name: string
  birthday?: Date
}
const curInfo: Info = { id: 'dqe2e', name: 'weizwz' }
console.log(curInfo?.birthday) // undefined

陣列

const nums: number[] = [1, 2, 3]
const answer: boolean[] = [false, true, false]
const names: string[] = ['w', 'e', 'i']

物件陣列

interface Info {
  id: string
}
const curInfos: Info[] = [ { id: 'dqe2e' }, { id: 'der24' } ]

函式

函式需要宣告引數型別和返回值型別

// week: string 指引數的型別；最後的: string 指返回值型別
function getWeek(week: string): string {
  return '星期' + week
}

箭頭函式

const getWeek = (week: string): string => {
  return '星期' + week
}
console.log(getWeek('六')) // '星期六'

沒有返回值 用 void 表示

interface Cat {
  weight: 5
}
const getName = (obj: Cat): void => {
  console.log(obj.weight + '斤')
}
getName({ weight: 5 }) // '5斤'

any型別

any 型別表示沒有任何限制，及時後續使用改變了型別也不會報錯。但是並不推薦使用 any，否則使用 TS 也失去了意義。

let x: any = 'weizwz'
x = 1
console.log(x) // 不報錯，輸出 1

真正的使用場景可能是老專案的升級，你無法確定老舊的程式碼具體是什麼型別；或者一些特殊情況，比如介面返回值型別不確定，或者後續使用時你要修改它的型別。

function getStatus(code: any): Boolean {
  return (code === '200' || code === 'ok' || code === 200 || code === true)
}
console.log(getStatus(400)) // false

型別聯合 |

某個變數可能是多個型別中的一個，用 | 來分隔

type Id = string | number
type stringBoolean = '1' | '0'

型別交叉 &

型別交叉一般用於多個型別組成的一個新型別，用 & 來連線

type Name = { name: string };
type User = Name & { age: number };

const zhangSan: User = { name: '張三', age: 18 }

型別斷言

手動指定型別，寫法是 值 as 型別 或 <型別>值。
為什麼要手動指定型別，是在某些特定情況下，我們已經確定這種型別是可以這樣操作，但是編譯器不確定，會報錯，所以我們使用型別斷言去告訴編譯器這樣做沒問題。

// 我們獲取到 id = name 介面元素
const $name = document.getElementById("name")
// 不是所有介面元素都有 value 屬性，在這裡我們已經確實我們拿的是 輸入框元素，
// 所以使用型別斷言告訴編譯器，如果存在這個元素，它一定是輸入框元素，有 value 屬性
if ($name) {
  ($name as HTMLInputElement).value
}

type 和 interface

type 命令用來定義一個型別的別名；
interface 用來宣告物件結構。

區別

  • type 能表示的任何型別組合; interface 只能表示物件結構的型別
  • type 後面需要用 =；interface 後面不需要 =
  • interface 可以繼承自（extends）interface 或物件結構的 type；type 可以透過 & 做物件結構的繼承
  • 多次宣告的同名 interface 會進行宣告合併；type 不允許多次宣告，一個作用域內不允許有多個同名 type

示例

type 使用

type stringBoolean = '1' | '0'

type Position = {
  x: number
  y: number
}

type Position3D = Position & { z: number }

const startPosition: Position = { x: 0, y: 10 }
const startPosition3D: Position3D = { x: 0, y: 10, z: 20 }

// type型別不允許多次宣告
type Position = { z: number } // 報錯，因為名為 Position 的型別已經被宣告

interface 使用

interface Position { x: number }
interface Position { y: number }

const startPosition: Position = { x: 0, y: 10 }

// 同名但有相同屬性，要求相同屬性的型別要一致，否則會報錯
interface Position { x: string } // 報錯，與剛開始定義的 x 型別衝突

繼承擴充套件

interface Position3D extends Position {
  z: number
}

const startPosition3D: Position3D = { x: 0, y: 10, z: 20 }

泛型

泛型一般用 T 表示，表示其中的引數/屬性/返回值可以是任何型別，如果有多個泛型，可以使用其他字母。
主要使用場景：有些物件中的屬性，或者方法裡的引數，可能有多個型別，具體型別根據使用場景來定。

基礎使用

// type 這裡的<T>就相當於型別入參，實際使用時傳入具體型別
type Empty<T> = T | undefined | null

const noData: Empty<[]> = []

多個泛型

interface Info<T, S> {
  name: string
  types: T[]
  weight: S
}

const tom: Info<string, number> = { name: 'tom', types: ['cat', 'animal'], weight: 5 }
const idx: Info<number, string> = { name: 'idx', types: [1], weight: 'first' }

函式

// 函式 <T>是泛型寫法；arr: T[] 是引數型別；:T 是返回值型別
function getFirst<T>(arr: T[]): T {
  return arr[0]
}

箭頭函式 <T,> 加逗號是為了避免編譯程式把 <> 解析成 jsx

const getFirst = <T,>(arr: T[]): T => {
  return arr[0]
}

const arr: number[] = [1, 2, 3]
console.log(getFirst<number>(arr), getFirst(arr)) // <number>可省略，列印出來都是 1

巢狀

使用巢狀可以提供程式碼複用率，如果型別之間差別點太多就沒必要了。

interface Tom<T> {
  name: string
  type: T
}
interface People {
  name: string
  type: 'person'
}
interface Cat {
  name: string
  type: 'animal'
}
// 我的兄弟 jakeTom
const myBrother: Tom<People> = {
  name: 'jakeTom',
  type: {
    name: 'my brother',
    type: 'person'
  }
}
// 我的貓咪 catTom
const myCat: Tom<Cat> = {
  name: 'catTom',
  type: {
    name: 'cat',
    type: 'animal'
  }
}

特殊用法

動態變數名

Record<Keys, Type> 返回一個物件型別，引數 Keys 用作鍵名，引數 Type 用作鍵值型別。

type stringKey = Record<string, string>
// 處理動態變數名
const list: stringKey = { img_1: 'img/1.png', img_2: 'img/2.png', img_3: 'img/3.png' }
for (const key in list) {
  console.log(list[key])
}
for(let i = 0; i < 3; i++) {
  console.log(list['img_' + (i + 1)])
}

vue3中的TS

響應式資料

在 xxx.d.ts 裡定義型別

interface Account = {
  id: string
  name: string
}

在 vue 介面裡使用

// 簡單型別可省略型別宣告
const loading = ref(false)
const user = ref<Account>({
  id: 'E2U1EU91U',
  name: 'weiz'
})

引數傳遞

父元件使用

<script setup lang="ts">
import { ref } from 'vue'
const user = ref<Account>({
  id: 'E2U1EU91U',
  name: 'weiz'
})
</script>
<template>
  <Children :account="user">
</template>

子元件接收引數

const props = defineProps<Account>()

如果沒有宣告 Account，則可以具體定義

const props = defineProps<{
  id: string
  name: string
}>()

元件例項型別

InstanceType<T> 是 ts 自帶的型別，能夠直接獲取元件完整的例項型別。

子元件

<script setup lang="ts">
const open = () => { console.log('開啟')}
// 子元件暴露方法
defineExpose({
  open
})
</script>

父元件

<script setup lang="ts">
import { ref } from 'vue'
import Children from './Children.vue'

type ChildCtx = InstanceType<typeof Children>
// 要和子元件的 ref 名稱一致
const childrenRef = ref<ChildCtx | null>(null)
// 呼叫子元件方法
const openChildren = () => {
 childrenRef.value?.open()
}
</script>
<template>
  <Children ref='childrenRef'/>
</template>

相關文章