能否以及如何为Svelte自定义store的$绑定值做TypeScript类型定义?
自定义Svelte Store的$前缀绑定类型标注实现方法
完全可以给带$前缀的自定义store绑定值添加类型标注,整个过程不需要额外的特殊语法,顺着Svelte内置的TS类型规则定义即可,具体实现步骤如下:
核心原理
Svelte的$语法糖本质是对符合契约的store对象做语法转换,只要一个对象存在subscribe方法,就会被识别为合法store,而$store的取值类型,完全由store内部subscribe方法传递的监听值类型决定——只需要在定义自定义store的时候把这个值的类型声明清楚,组件里写{$xxx}的时候就会自动获得对应的类型提示,不需要单独给$绑定写标注。
具体代码实现
1. 定义store的类型结构
首先把原示例的JS文件改为TS文件,基于Svelte内置的Readable类型扩展自定义方法,明确store的值类型和自定义方法的签名:
// 从svelte/store引入内置类型和writable方法 import { writable, type Readable } from 'svelte/store'; // 第一步:定义store监听值的类型,简单值可以直接用基础类型,复杂结构就写自定义接口 // 比如原示例count的取值是数字类型,直接用number即可;如果是复杂结构就替换成自己的接口,例如: // interface CountState { // value: number // lastModified: Date // } // 第二步:定义自定义store的整体结构——继承Readable<值类型>,再补上自定义的方法签名 interface CountStore extends Readable<number> { increment: () => void; decrement: () => void; reset: () => void; } function createCount(): CountStore { // 初始化writable的时候传入对应类型的初始值,TS会自动校验初始值类型是否匹配 const { subscribe, set, update } = writable(0); return { // 必须保留subscribe方法,这是被$语法糖识别为合法store的核心 subscribe, increment: () => update(n => n + 1), decrement: () => update(n => n - 1), reset: () => set(0) }; } export const count = createCount();
2. 组件中自动获得类型提示
对应的app.svelte文件只需要把script标签标记为TS模式,不需要额外给{$count}写类型断言:
<script lang="ts"> import { count } from './stores.ts'; </script> <!-- 这里的$count会自动被TS识别为number类型,类型校验全链路生效 --> <h1>The count is {$count}</h1> <button on:click={count.increment}>+</button> <button on:click={count.decrement}>-</button> <button on:click={count.reset}>reset</button>
使用自定义接口的扩展场景
如果你的store存的是复杂结构,只需要把之前定义的基础值类型替换成自己的接口即可,全链路的类型推断会自动生效:
import { writable, type Readable } from 'svelte/store'; // 自定义的store值结构 interface UserInfo { id: number; username: string; isLogin: boolean; } // 自定义store的整体结构 interface UserStore extends Readable<UserInfo> { login: (username: string) => void; logout: () => void; } function createUserStore(): UserStore { const { subscribe, set, update } = writable<UserInfo>({ id: 0, username: '', isLogin: false }); return { subscribe, login: (username) => update(state => ({ ...state, username, isLogin: true, id: Date.now() })), logout: () => set({ id: 0, username: '', isLogin: false }) }; } export const user = createUserStore();
这个场景下,在组件中写{$user}的时候,TS会自动识别这是UserInfo类型的对象,直接访问{$user.username}这类字段时会获得完整的类型提示,写错字段名时会直接报错。
注意事项
- 只要store的
subscribe方法类型符合Svelte的契约要求,无论你扩展多少自定义方法,$语法糖的类型推断都不会失效 - 显式给自定义store定义接口的好处是,TS会自动校验你返回的对象有没有漏实现约定的方法,从定义层面避免低级错误
- 不需要给组件里的
{$xxx}做单独的类型断言,所有类型都会顺着store的定义自动传递到组件表达式中
内容的提问来源于stack exchange,提问作者TTT
相关产品推荐
相关产品推荐

