Track: Typescript types support

[hugomrdias]

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 = ⛔

Status	Repo/PR	Owner
✅	aegir ipfs/aegir#671 ipfs/aegir#701	-
✅	ipfs-utils ipfs/js-ipfs-utils#89	-
✅	interface-datastore ipfs/interface-datastore#56	-
✅	datastore-core ipfs/js-datastore-core#39	-
✅	datastore-level ipfs/js-datastore-level#53	-
✅	datastore-pubsub ipfs/js-datastore-pubsub#60	@achingbrain
✅	datastore-fs ipfs/js-datastore-fs#62	-
✅	ipfs-repo ipfs/js-ipfs-repo#275	@hugomrdias
✅	ipfs-unixfs ipfs/js-ipfs-unixfs#114 ipfs/js-ipfs-unixfs#122	@achingbrain
✅	ipfs-bitswap ipfs/js-ipfs-bitswap#261	@Gozala
✅	is-ipfs ipfs-shipyard/is-ipfs#39	@achingbrain
✅	ipns ipfs/js-ipns#106	@achingbrain
✅	ipfs-block-service ipfs/js-ipfs-block-service#136	@achingbrain
✅	cids multiformats/js-cid#131	-
✅	multihash multiformats/js-multihash#104	-
✅	multibase multiformats/js-multibase#72	-
✅	multiaddr multiformats/js-multiaddr#159	@hugomrdias
✅	multicodec multiformats/js-multicodec#70	-
✅	multihashing-async multiformats/js-multihashing-async#92	-
✅	libp2p libp2p/js-libp2p#802	-
✅	libp2p-interfaces https://github.com/libp2p/js-libp2p-interfaces	-
⛔	ipfsd-ctl
✅	ipfs #3550	@achingbrain
✅	err-code	-

Documentation

https://github.com/ipfs/aegir/blob/master/md/ts-jsdoc.md

Improvement issues

ipfs/aegir#619 (comment)

External issues to track

TypeStrong/typedoc#1248 (comment)
microsoft/TypeScript#41672

[bluelovers]

where the branch of it? or it not yet started?

[hugomrdias]

not started yet, i will start in the next couple of weeks

[bluelovers]

ipfs/js-ipfs-utils#26

[dapplion]

Is it possible to externally contribute to the Typescript support effort?

[bluelovers]

@dapplion https://github.com/bluelovers/ws-ipfs/tree/master/packages/ipfs-types

[hugomrdias]

Is it possible to externally contribute to the Typescript support effort?

@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]

Is it possible to externally contribute to the Typescript support effort?

@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

Thanks! Is it on the roadmap to migrate to Typescript?