How to make inline snippets with JSdocs less verbose?

[daviareias]

I have this snippet for example that if I want to type becomes extremely verbose, because you have to add @type to each parameter, I can just transform it into a component instead, but the snippet is quite short:

{#snippet MarketCell(
  /** @type {string} */ label,
  /** @type {string} */ value,
  /** @type {number} */ hiddenVariants,
  /** @type {number} */ hiddenProducts,
  /** @type {number|undefined} */ index,
  /** @type {boolean|undefined} */ primary,
  /** @type {boolean|undefined} */ global,
)}
...
{/snippet}

[brunnerh]

Since rest arguments are currently not supported, alternatives are limited.

If you collect the arguments into an options object, you can reduce it to one type definition, but the @render code will become longer since all properties have to be named.

{#snippet MarketCell(
  /** @type {{
    label: string,
    value: string,
    hiddenVariants: number,
    hiddenProducts: number,
    index: number | undefined,
    primary: boolean | undefined,
    global: boolean | undefined,
  }} */ options
)}
...
{/snippet}

{@render MarketCell({
  label: 'a',
  value: 'b',
  hiddenVariants: 1,
  // ...
})}

As an alternative to rest args, you could use a single tuple argument, but editor tooling when writing @render code will probably not be as nice¹.

{#snippet MarketCell(
  /** @type {[
    label: string,
    value: string,
    hiddenVariants: number,
    hiddenProducts: number,
    index: number | undefined,
    primary: boolean | undefined,
    global: boolean | undefined,
  ]} */ options
)}
...
{/snippet}

{@render MarketCell(['a', 'b', 1, /* ... */])}

Footnotes

1. I do not get the current tuple element types/names displayed via popup in VS Code. Type checking works as expected. ↩