How to use jsdoc for typesafety on Ionic webcomponents

Open
#2,658 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

The issue names no documentation file, test, or entry point. Start by reviewing the existing Ionic web components documentation and the linked JSDoc example; done means documenting how to apply type annotations to all or individual components in Svelte, including the stated wrapper limitations.

Written by the indexing model from the issue text.

Description

triage

Hi

Currently hitting a wall for the use of Ionic webcomponents in Svelte

I would like to use JSdoc type annotations to have typesafety and completion in the Ide

I reckon these are there but can you add some docs on how to use these for all and/or individual components?

Example
https://dev.to/dakmor/type-safe-web-components-with-jsdoc-4icf

Svelte native wrappers limitations hence this request

Thx

Dominant language
MDX
Stars
621
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
86

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ionic-team/ionic-docs

All issues in ionic-team/ionic-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.