Skip to content
← Back to rules

typescript/prefer-readonly Nursery

💭 This rule requires type information.

它的作用

要求从未重新赋值的类成员标记为 readonly

为什么这是不好的?

从不更改的成员应声明为 readonly,以显式表达类不变量,并防止意外修改。

示例

此规则的错误代码示例:

ts
class Counter {
  private value = 0;

  getValue() {
    return this.value;
  }
}

此规则的正确代码示例:

ts
class Counter {
  private readonly value = 0;

  getValue() {
    return this.value;
  }
}

配置

此规则接受一个配置对象,包含以下属性:

onlyInlineLambdas

type: boolean

默认值: false

仅对立即使用内联函数值初始化的成员进行检查。

如何使用

要通过配置文件或 CLI 启用此规则,可以使用:

json
{
  "rules": {
    "typescript/prefer-readonly": "error"
  }
}
bash
oxlint --type-aware --deny typescript/prefer-readonly

参考资料