ReturnValueDescription interface
Description of an exposed method's return value, as parsed from its JSDoc.
Signature:
export interface ReturnValueDescription
Remarks
Always present on a MethodDescription, even when the method has no @returns tag — in which case the type is 'any'.
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
string |
Prose describing the return value, from the | ||
|
string |
The return type from the method's | ||
|
string |
Legacy duplicate of ReturnValueDescription.tsType — always the identical string. |
Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.