TypeScript 系列:satisfies 的实用之处

假设我们要定义一份配置,如果直接写则没有类型提示,写错字段名或少写字段 TS 也不会报错。

ts 复制代码
const TIME_UNITS_TRANSLATIONS = {
    day: {
        singular: 'day',
        plural: 'days',
    },
    hour: {
        singular: 'hour',
        plural: 'hours',
    },
    minute: {
        singular: 'minute',
        plural: 'minutes',
    },
    second: {
        singular: 'second',
        plural: 'seconds',
    },
    millisecond: {
        singular: 'millisecond',
        plural: 'milliseconds',
    },
}

但若加上类型,确实解决了字段提示的问题,但是又会出现新问题:

ts 复制代码
type ITimeUnit = 'day' | 'hour' | 'minute' | 'second' | 'millisecond'
type IForms = {
    singular: string
    plural: string
}

const TIME_UNITS_TRANSLATIONS: Record<ITimeUnit, IForms> = {
    day: {
        singular: 'day',
        plural: 'days',
    },
    hour: {
        singular: 'hour',
        plural: 'hours',
    },
    minute: {
        singular: 'minute',
        plural: 'minutes',
    },
    second: {
        singular: 'second',
        plural: 'seconds',
    },
    millisecond: {
        singular: 'millisecond',
        plural: 'milliseconds',
    },
}

当我们 hover 变量其类型变成

const TIME_UNITS_TRANSLATIONS: Record<ITimeUnit, IForms>

而不加类型之前,VSCode 是能完整提示到字段级别的。这样便于我们观察变量,无需跳转到其定义处就能知道里面有哪些字段。

ts 复制代码
const TIME_UNITS_TRANSLATIONS: {  
    day: {  
        singular: string;  
        plural: string;  
    };  
    hour: {  
        singular: string;  
        plural: string;  
    };  
    minute: {  
        singular: string;  
        plural: string;  
    };  
    second: {  
        singular: string;  
        plural: string;  
    };  
    millisecond: {  
        singular: string;  
        plural: string;  
    };  
}

能否一举两得 - satisfies to the rescue 💉

ts 复制代码
const TIME_UNITS_TRANSLATIONS = {
    day: {
        singular: 'day',
        plural: 'days',
    },
    hour: {
        singular: 'hour',
        plural: 'hours',
    },
    minute: {
        singular: 'minute',
        plural: 'minutes',
    },
    second: {
        singular: 'second',
        plural: 'seconds',
    },
    millisecond: {
        singular: 'millisecond',
        plural: 'milliseconds',
    },
} satisfies Record<ITimeUnit, IForms>

这时候 hover 后发现我们平铺的类型定义又回来,而且字段能自动提示。

更进一步 - as const satisfies ... 🔬

能否做到更好?我们试试 as const satisfies ...

ts 复制代码
const TIME_UNITS_TRANSLATIONS = {
    day: {
        singular: 'day',
        plural: 'days',
    },
    hour: {
        singular: 'hour',
        plural: 'hours',
    },
    minute: {
        singular: 'minute',
        plural: 'minutes',
    },
    second: {
        singular: 'second',
        plural: 'seconds',
    },
    millisecond: {
        singular: 'millisecond',
        plural: 'milliseconds',
    },
} as const satisfies Record<ITimeUnit, IForms>

此时发现还能具体到字段的值,完美!

第二个例子

这个例子帮助我们更好理解 satisifies。

ts 复制代码
type User = {
  id: string;
  name: string;
  age?: number;
};

const alice = {
  id: "123",
  name: "Alice",
  age: 30,
} satisfies User; // ✅ 类型仍然是 { id: string; name: string; age: number }

// 仍然可以访问 alice.age.toFixed(2),因为 age 被推断为 `number` 而不是 `number | undefined`

如果改成普通的类型标注:

ts 复制代码
const alice: User = {
  id: "123",
  name: "Alice",
  age: 30,
}; // 类型变成了 User 即 { id: string; name: string; age?: number }

alice.age.toFixed(2)
// ^^^^ 'alice.age' is possibly 'undefined'.(18048)

代码将报错因为 age 被推断为number | undefined 而不是 number:

但实际上我们知道 alice 的 age 并不为空(30)。

到这里我们就学会了何时在项目中使用 satisifies 了 🎉!

总结

当我们想验证变量类型但不改变类型本身 ,可以试试 satisifies,打破鱼与熊掌二者不可兼得。

参考

相关推荐
濮水大叔1 天前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
深兰科技2 天前
走出进博展馆寻AI方案,巴西政商联合体参访深兰科技洽商中巴产业数字化合作
人工智能·typescript·深兰科技·中巴产业数字化·巴西政商联合体·ai方案·进博会
FungLeo3 天前
成为全栈·Vue 管理后台篇·Biome、类型检查、构建和API 代理如何组成质量门禁
前端·javascript·vue.js·typescript·vite·前端工程化·biome
泯泷3 天前
改一个字,整段都红了?——中文内容差异对比的算法与协议设计
前端·javascript·typescript
4cos904 天前
pi学习笔记-AgentLoop
typescript
afumu5 天前
让本机 Agent 指挥浏览器里的多个网页 AI:一套 127.0.0.1 控制协议的设计取舍
chrome·typescript
濮水大叔5 天前
Cabloy/Vona 为什么不需要 NestJS 的 Dynamic Module
typescript·node.js·nestjs
浪遏6 天前
recruitment-cli:让 AI 接手求职招聘,从架构到一次发送超时
架构·typescript·node.js
律宏阔7 天前
微信小程序 + Taro 从 ESLint 迁移到 Oxlint 让项目代码检查速度提升近 12 倍
前端·typescript·eslint
瓦瓦gogo7 天前
从一个 TypeScript 函数开始理解 MCP 协议
linux·ubuntu·typescript