ArgDescription interface

Description of one argument of an exposed method, as parsed from its JSDoc.

Signature:

export interface ArgDescription

Properties

Property	Type	Description
description	string	Prose describing the argument, taken from the text after the name on the JSDoc `@param` line. Empty string when undocumented.
isOptional	boolean	Whether the argument was documented as optional, i.e. written `[name]` in the JSDoc. A TypeScript `?` or a default value alone does not set this.
name	string	Parameter name, from the JSDoc `@param` when documented, otherwise read from the method's own signature.
tsType	string	The argument's type as written in the method's JSDoc, defaulting to `'any'` when undocumented. This is what a generated client emits into the method signature. Never empty.
type	string	Legacy duplicate of ArgDescription.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.