TypeScript中仅含设置器的属性类型安全问题及解决方案咨询

问题原因 #

你遇到的情况源于TypeScript对仅定义setter的属性的类型推断逻辑：早期版本会将其推断为any，允许无限制读取；新版本默认推断为undefined，但如果未开启严格空检查，编译器不会拦截读取操作，最终导致运行时读取到undefined并触发报错。

两种最优解决方式 #

1. 利用TSConfig严格模式自动拦截

开启strictNullChecks配置（该选项包含在strict: true的集合中），此时TypeScript会将仅含setter的属性类型推断为undefined，读取时直接触发编译错误，提示你该值可能为undefined，从编译阶段避免运行时问题。

开启后，你的代码console.log(x.writeOnlyProp.toString())会直接报编译错误，因为TypeScript明确知道x.writeOnlyProp可能是undefined，不允许直接调用方法。

2. 显式声明仅写属性的类型约束

如果需要更明确地表达“该属性仅可赋值、不可读取”的设计意图，可以在类中额外声明属性的读取类型为never，彻底阻止外部读取操作：

class X {
    set writeOnlyProp(value: number) {
        // 执行一些设置操作
    }
    // 声明读取该属性时类型为never，编译阶段直接拦截读取行为
    declare writeOnlyProp: never;
}

const x = new X()
x.writeOnlyProp = 123; // 正常执行赋值
console.log(x.writeOnlyProp.toString()) // 编译错误：无法访问类型为never的属性

这种方式比添加返回undefined的getter更贴合设计初衷，不需要额外的冗余代码。

内容的提问来源于stack exchange，提问作者Lionel Rowe