JSON schema type based on OpenAPI version
Whether the function is asynchronous.
true if the function returns a Promise, false for synchronous
functions. Useful for runtime execution handling.
OptionaldeprecatedWhether the function is deprecated.
Set from the @deprecated JSDoc tag. Indicates the function should no
longer be used and may be removed in future versions.
OptionaldescriptionFull function description.
Complete documentation extracted from JSDoc comment body. May include markdown formatting, examples, and detailed explanations.
Function name identifier.
The name used to call this function. Derived from the method name in the source class/interface.
Return type information.
Contains the return type schema and documentation. undefined when the
function returns void or has no return type annotation.
Array of function parameters.
Ordered list of parameters with their names, types, and documentation. Parameters preserve their declaration order.
OptionalsummaryBrief summary of the function.
Short one-line description extracted from the first line of JSDoc comment. Intended for quick reference in documentation.
OptionaltagsCategory tags for organization.
Extracted from @tag JSDoc annotations. Useful for grouping related
functions in documentation or filtering.
Complete metadata for a single function.
Contains all information needed to describe a function in JSON Schema format, including parameters, return type, and documentation extracted from JSDoc comments.