Private members should be marked as
readonly JS-0368
Anti-pattern
Major
4 months ago
—
4 months old
Member '_log' is never reassigned; mark it as
readonly 32 public relays: RelayPool;
33 public _pubkey: string;
34 private _privkey: string;
35 private _log: Logger; 36
37 constructor() {
38 // Bootstrap Relays
Description
Private members are marked as readonly if they're never modified outside of the constructor.
Bad Practice
class Container {
// These member variables could be marked as readonly
private neverModifiedMember = true;
private onlyModifiedInConstructor: number;
public constructor(
onlyModifiedInConstructor: number,
// Private parameter properties can also be marked as readonly
private neverModifiedParameter: string,
) {
this.onlyModifiedInConstructor = onlyModifiedInConstructor;
}
}
Recommended
class Container {
// Public members might be modified externally
public publicMember: boolean;
// Protected members might be modified by child classes
protected protectedMember: number;
// This is modified later on by the class
private modifiedLater = 'unchanged';
public mutate() {
this.modifiedLater = 'mutated';
}
}