@readonly

Tag Kind
Modifier
TSDoc Reference
@readonly

The @readonly tag indicates that a reflection should be documented as non-writable, even if writable according to TypeScript.

Example

export class Readable {
/** @readonly */
get prop() {
return 1;
}

/** Will be removed from the documentation due to the readonly tag */
set prop(_: number) {
throw new Error("Not permitted");
}
}