This repository was archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
This repository was archived by the owner on Feb 12, 2024. It is now read-only.
Track: Typescript types support #2945
Copy link
Copy link
Closed
Labels
EpicP0Critical: Tackled by core team ASAPCritical: Tackled by core team ASAPawesome endeavourexp/wizardExtensive knowledge (implications, ramifications) requiredExtensive knowledge (implications, ramifications) requiredkind/trackingA meta-issue for tracking workA meta-issue for tracking worktopic/docsDocumentationDocumentation
Description
We will use JSDoc to declare types for the top level API first and internally we will add types incrementally where we feel it adds value.
A TS config will be added to the repo to enable type declaration generation from JSDoc comments.
Type declaration tests will be added as we see fit and we will add a ts type check job to our CI.
Repo track list
Done = ✅
In Progress = 🚧
TODO = ⛔
Documentation
https://github.com/ipfs/aegir/blob/master/md/ts-jsdoc.md
Improvement issues
External issues to track
TypeStrong/typedoc#1248 (comment)
microsoft/TypeScript#41672
AuHau, Xmader, nickdex, NatoBoram, pithuene and 21 moredapplion, badkk, AlexxNica and marc2332AlexxNicadapplion, matthewjosephtaylor, gnidan, AlexxNica and D4nte
Metadata
Metadata
Assignees
Labels
EpicP0Critical: Tackled by core team ASAPCritical: Tackled by core team ASAPawesome endeavourexp/wizardExtensive knowledge (implications, ramifications) requiredExtensive knowledge (implications, ramifications) requiredkind/trackingA meta-issue for tracking workA meta-issue for tracking worktopic/docsDocumentationDocumentation
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
bluelovers commentedon Mar 25, 2020
where the branch of it? or it not yet started?
hugomrdias commentedon Mar 27, 2020
not started yet, i will start in the next couple of weeks
bluelovers commentedon Mar 27, 2020
ipfs/js-ipfs-utils#26
dapplion commentedon May 6, 2020
Is it possible to externally contribute to the Typescript support effort?
bluelovers commentedon May 6, 2020
@dapplion https://github.com/bluelovers/ws-ipfs/tree/master/packages/ipfs-types
hugomrdias commentedon May 14, 2020
@dapplion sure just pick a repo in the list and start adding JSDocs types to the top level api and mention me in the PR
dapplion commentedon May 15, 2020
Thanks! Is it on the roadmap to migrate to Typescript?
63 remaining items
achingbrain commentedon May 26, 2021
This was shipped in
ipfs@0.55.x
andipfs-core@0.6.x
so I think we can close this now.If there are further issues with the types, new issues can be opened and dealt with case by case.
Thanks everyone, amazing work!
feat: add typeScript support (#3236)
feat: add typescript support (#3267)