This repository was archived by the owner on Feb 12, 2024. It is now read-only.
This repository was archived by the owner on Feb 12, 2024. It is now read-only.
Track: Typescript types support #2945
Closed
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
Metadata
Metadata
Assignees
Labels
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
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?
78 remaining items