Display default values for property types.

🔎 Search Terms

• jsdoc property and default tooltip
• jsdoc declare default values on object properties
• use jsdoc property with default

🕗 Version & Regression Information

Unsure if it's always been this way.

⏯ Playground Link

https://www.typescriptlang.org/play/?filetype=js#code/LAKFHoCpNACTYAEAuBPADgUwCaYGawDeA9gEYBWmAxsgL6wAKATsegM5wKLotZNpEA5GwC2g2AB9YgkdnFTBAGwDmg+gG1mrNgDo2ASwBemALwy5AXVgAhAK7JkxAHawDxnZyQ9WmfqiJsyEz6TsoaWuw6igCGpJiKVnYOzrAxcYoeIPDgoBDQnohMmMi2TE5sRBFstAW4eNG2ishErkaYAFzSsoIANKmx8Z22TnUhOLA1WZA5IHjDNPopysVVABQAlERwsDtFJWVEk5OgisUtbpiwJl1yfWnxE1ewy8hr66BAA

💻 Code

/**
 * @typedef {object} Props
 * @property {'sm' | 'md' | 'lg'} [Props.size='md'] Button size.
 * @property {string} [Props.label] Button label.
 */

/**
 * @returns {Props}
 * @default { size: 'md', label: undefined }
 */
function getProps() {
    return {}
}

let { size = 'md', label } = getProps()

🙁 Actual behavior

Tooltip when hovering size destructured property:

let size: "sm" | "md" | "lg"
Button size.

🙂 Expected behavior

Tooltip when hovering size destructured property:

let size: "sm" | "md" | "lg"
Button size.
---
@default 'md'

Additional information about the issue

Potentially relates to https://github.com/microsoft/TypeScript/issues/24746

When defining object property types using JSDoc default value notation, such as @property {'sm' | 'md' | 'lg'} [Props.size='md'], I'd like to see tooltip details about the default value. I assume the only way to denote default values with @property is to use [key=value] notation since @default cannot be inlined.

Beginne mit dem verlinkten TypeScript Playground und reproduziere den JSDoc-@property-Fall mit dem Standardwert. Vergleiche ihn anschließend mit dem zugehörigen Issue 24746. Verfolge, wie der Tooltip für die destrukturierte size erzeugt wird, und sorge dafür, dass das fertiggestellte Verhalten den dokumentierten Standardwert anzeigt, etwa @default 'md'.