Assign value to `readonly` properties from methods called by the constructor

31.9k Views Asked by At

I have a simple class, and I want to assign a value to a readonly property in a method initiated by the constructor, but it says [ts] Cannot assign to 'readOnlyProperty' because it is a constant or a read-only property. Why can't I assign a value to the property even though I am calling process from the constructor?

Sample Code:

class C {
    readonly readOnlyProperty: string;
    constructor(raw: string) {
        this.process(raw);
    }
    process(raw: string) {
        this.readOnlyProperty = raw; // [ts] Cannot assign to 'readOnlyProperty' because it is a constant or a read-only property.
    }
}
5

There are 5 best solutions below

0
On BEST ANSWER

I usually use this workaround:

get myValue(): boolean { return this._myValue }
private _myValue = true

Result:

  • myValue – is readonly from the outside
  • _myValue – can be modified within the class

The advantage of this workaround is that your IDE can refactor your property. Also, we do not misuse a non-writable readonly property, which can lead to errors when compiling, optimizing, or code review. If not today, then in the near future. That's why I wouldn't use something like:

// hack, may cause problems (refactoring is not possible)
(this as any).readOnlyProperty = raw

// hack, may cause problems (we write a non-writable)
(this.readOnlyProperty as boolean) = raw

// hack, may cause problems (refactoring is not possible)
Object.assign(this, {readOnlyProperty: raw})
0
On

When you create a separate function to assign the value, this separate function can be used from somewhere else than the sole constructor. The compiler will not check (and for a public function, will not even be able to check) that the function is only called from constructor. So the error.

You have 2 workarounds to assign the value anyway. The cleaner would be to put the core of your separate function into the constructor. The other one, which will make you loose the type checking and so is not recommanded unless you really know what you are doing would be to convert this into any:

(this as any).readOnlyProperty = raw
1
On

just try

Object.assign(this, {readOnlyProperty: raw})
0
On

Pretty old question but thought it was still worth sharing how I usually get past this. I tend to return the value you want to set from the method, then you're still separating the logic, while also keeping readonly without any arguably illegal bypasses. e.g...

class C {
    readonly readOnlyProperty: string;
    constructor(raw: string) {
        this.readOnlyProperty = this.process(raw);
    }
    process(raw: string) {
         // ...some logic that processes 'raw'...

        return raw;
    }
}
2
On

Instead of casting this as any, you should enforce type checking by modifying just this property:

// OK
(this.readOnlyProperty as string) = raw; 

// TS2322: Type '5' is not assignable to type 'string'.
(this.readOnlyProperty as string) = 5;