DocumentationElementPropsinterface
{
readonly kind?: string | undefined;
readonly signatures?: ImmutableArray<string> | undefined;
readonly params?: ImmutableArray<DocumentationParam> | undefined;
readonly returns?: ImmutableArray<DocumentationReturn> | undefined;
readonly throws?: ImmutableArray<DocumentationThrow> | undefined;
readonly examples?: ImmutableArray<DocumentationExample> | undefined;
readonly class?: string | undefined;
readonly readonly?: boolean | undefined;
readonly extends?: string | undefined;
readonly implements?: ImmutableArray<string> | undefined;
readonly types?: ImmutableArray<string> | undefined;
readonly properties?: ImmutableArray<DocumentationParam> | undefined;
}| Property | Type | |
|---|---|---|
.kind | string | readonly |
.signatures | ImmutableArray<string> | Immutable array: an array that cannot be changed. readonly |
.params | ImmutableArray<DocumentationParam> | Immutable array: an array that cannot be changed. readonly |
.returns | ImmutableArray<DocumentationReturn> | Immutable array: an array that cannot be changed. readonly |
.throws | ImmutableArray<DocumentationThrow> | Immutable array: an array that cannot be changed. readonly |
.examples | ImmutableArray<DocumentationExample> | Immutable array: an array that cannot be changed. readonly |
.class | string | Name of the class/interface this member belongs to (e.g. "Store" for Store.get()). Set only on methods and properties. readonly |
.readonly | boolean | Whether the property is read-only — a readonly field, or a getter with no matching setter. readonly |
.extends | string | Full type text of the class/interface this extends, including any generic arguments (e.g. "AbstractStore<string>", "Omit<StringSchemaOptions, 'value'>"). Resolved to a link at render time, trimming generics to the bare name; builtins/wrappers that don't resolve stay as text. readonly |
.implements | ImmutableArray<string> | Full type text of the interfaces this implements, including generic arguments (e.g. ["Serializable<string>"]). Resolved to links at render time (generics trimmed for lookup); builtins simply stay as text. readonly |
.types | ImmutableArray<string> | Type names referenced by a type alias's body (e.g. ["OtherType"] for type X = string | OtherType).- Raw identifier strings — resolved to links at render time; the alias's own generic parameters and primitive keywords are excluded, and unresolved names stay as plain text. readonly |
.properties | ImmutableArray<DocumentationParam> | Structured data-member list for a class, interface, or object-literal type — each property's name, type, optionality, default, and description. Methods stay as child elements; only data members live here.- Reuses the DocumentationParam shape so it can both render the type's own Properties table and be flattened into an options-bag parameter's individual fields at render time. readonly |
Props for a documented code symbol — a single shape for any kind of code element.
kinddistinguishes the symbol category (e.g."function","class","property", or any string).- All props are optional — not every kind uses every prop (e.g.
returnsonly makes sense for functions). signaturesis an array so overloaded function/method declarations can each contribute their own signature to the same documentation element.