You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript:如何实现state参数本身只读但其属性可修改?

如何让TypeScript函数参数本身只读(不可重新赋值)但属性可修改

核心需求

确保state参数本身无法被重新赋值,但它的属性可以自由修改:

  • 禁止state = {...}这类重新赋值操作
  • 允许state.a = "new value"这类属性修改操作
  • 避免使用Readonly<State>(会导致属性也只读)
  • 可使用TypeScript 5.x特性

现有问题

  • 直接使用State类型作为参数,允许重新赋值state变量
  • 封装为readonly state的对象后,解构const { state } = args或let { state } = args仍能重新赋值解构后的state变量

解决方案

方案1:利用唯一符号(Unique Symbol)限制变量赋值

通过给state参数的类型添加一个私有唯一符号,让重新赋值时因类型不匹配报错,同时不影响属性修改:

// 定义私有唯一符号,用于标记只读变量
declare const __readonlyVar: unique symbol;
type ReadonlyVariable<T> = T & { [__readonlyVar]: never };

export type GameDeviceFactory<State, Events extends { in: unknown; out: unknown }> = (
  state: ReadonlyVariable<State>,
  emitEvent: (event: Events["out"]) => Promise<void>,
) => any;

const Some: GameDeviceFactory<{a: string}, { in: unknown; out: unknown }> = (state) => {
  state = {a: ""}; // ❌ 报错:类型缺少唯一符号属性,无法赋值
  state.a = "";    // ✅ 正常允许修改属性
};

方案2:封装参数对象并限制解构后赋值

如果需要将参数封装为对象,同样可以用唯一符号标记state,同时禁止直接修改args.state,也限制解构后的赋值操作:

type UnknownEventsInterface = { in: unknown; out: unknown };
declare const __preventAssign: unique symbol;
type NoAssign<T> = T & { [__preventAssign]: never };

type FactoryArgs<State, Events extends UnknownEventsInterface> = {
  readonly state: NoAssign<State>;
  readonly emitEvent: (event: Events["out"]) => Promise<void>;
};

export type GameDeviceFactory<State, Events extends UnknownEventsInterface> = (
  args: FactoryArgs<State, Events>,
) => any;

const Some: GameDeviceFactory<{a: string}, { in: unknown; out: unknown }> = (args) => {
  args.state = {a: ""}; // ❌ 报错:state是只读属性,无法直接赋值
  args.state.a = "";    // ✅ 允许修改属性

  let { state } = args;
  state = {a: ""};      // ❌ 报错:类型缺少唯一符号属性,无法赋值
};

原理说明

  • 唯一符号(unique symbol)是TypeScript的私有类型标记,外部无法创建包含该符号的对象,因此重新赋值时会触发类型不匹配错误
  • 这种方式仅限制变量的重新赋值操作,不会影响对象属性的可写性,完美契合需求

内容的提问来源于stack exchange,提问作者ScreamZ

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.26 10:02:49