Skip to content
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
@hugomrdias

Description

@hugomrdias
Member

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

Activity

added
exp/wizardExtensive knowledge (implications, ramifications) required
P0Critical: Tackled by core team ASAP
kind/enhancementA net-new feature or improvement to an existing feature
on Mar 24, 2020
self-assigned this
on Mar 24, 2020
bluelovers

bluelovers commented on Mar 25, 2020

@bluelovers
Contributor

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

hugomrdias

hugomrdias commented on Mar 27, 2020

@hugomrdias
MemberAuthor

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

bluelovers

bluelovers commented on Mar 27, 2020

@bluelovers
Contributor
dapplion

dapplion commented on May 6, 2020

@dapplion

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

bluelovers

bluelovers commented on May 6, 2020

@bluelovers
Contributor
hugomrdias

hugomrdias commented on May 14, 2020

@hugomrdias
MemberAuthor

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

dapplion commented on May 15, 2020

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

78 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

EpicP0Critical: Tackled by core team ASAPawesome endeavourexp/wizardExtensive knowledge (implications, ramifications) requiredkind/trackingA meta-issue for tracking worktopic/docsDocumentation

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @Gozala@5310@bluelovers@hugomrdias@DeedleFake

      Issue actions

        Track: Typescript types support · Issue #2945 · ipfs/js-ipfs