PropertyData

Represents property information of an object type. Used to describe object properties in ReturnData and TypedefData.

Signature

interface PropertyData {
  name: string;
  type?: string;
  description: string;
  required: boolean;
  defaultValue?: string;
  nested?: PropertyData[];
}

Properties

• nameRequired · string
  

  Name of the property

• type · string
  

  Type of the property

• descriptionRequired · string
  

  Description of the property

• requiredRequired · boolean
  

  Whether the property is required

• defaultValue · string
  

  Default value if the property is optional

• nested · PropertyData[]
  

  Nested property data for object properties