ReturnData

Represents the parsed result of @returns tags in JSDoc. Used to describe return value information of functions.

Signature

interface ReturnData {
  type: string;
  name?: string;
  description: string;
  properties?: PropertyData[];
}

Properties

• typeRequired · string
  

  Type of the return value

• name · string
  

  Optional name of the return value

• descriptionRequired · string
  

  Description of the return value

• properties · PropertyData[]
  

  Array of property information if the return value is an object