DocumentationParaminterface

{
	readonly name: string;
	readonly type?: string | undefined;
	readonly description?: string | undefined;
	readonly optional?: boolean | undefined;
	readonly default?: string | undefined;
	readonly readonly?: boolean | undefined;
}
PropertyType
.namestring
required readonly
.typestring
Type expression (e.g. "string", "number"); renderers default to "unknown" when missing. readonly
.descriptionstring
readonly
.optionalboolean
readonly
.defaultstring
Default-value expression from the parameter's initializer (e.g. "false", "{}"), or undefined when the parameter has none. readonly
.readonlyboolean
Whether this is a read-only data member (a readonly property, or a getter with no matching setter). Only meaningful for properties, not function params. readonly

A single parameter for a documented code symbol.