DocumentationDescriptionPropsinterface

{
	readonly description?: string | undefined;
	readonly default?: string | undefined;
	readonly optional?: boolean | undefined;
	readonly readonly?: boolean | undefined;
}
PropertyType
.descriptionstring
Already-resolved description text (hand-written, or fallen back to the referenced type's own description), rendered as inline markup. readonly
.defaultstring
Default-value expression — rendered as a trailing Defaults to … note (linked when it's a documented token). readonly
.optionalboolean
Whether the value is optional — pass an explicit boolean to opt into the note: false appends Required. (when there's no default), true appends nothing. Leave undefined to suppress the note entirely (e.g. for returns/throws). readonly
.readonlyboolean
Whether the value is read-only — appends a trailing Readonly note at the very end (after any Defaults to … / Required.). readonly

Props for DocumentationDescription — a description cell's resolved text, plus an optional default/optionality note.