MethodDescription interface

Description of one exposed method: its summary, its positional arguments and its return value.

Signature:

export interface MethodDescription 

Properties

Property

Modifiers

Type

Description

arguments

ArgDescription[]

The method's arguments, in positional order.

description

string

The method's JSDoc summary, or an empty string when undocumented.

returns

ReturnValueDescription

The method's return value description. Always present.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.