multiformats / js-cid

CID implementation in JavaScript
MIT License
97 stars 39 forks source link

Clarify intent of type parameter in type defs #84

Open Gozala opened 5 years ago

Gozala commented 5 years ago

This question came up https://github.com/multiformats/js-cid/pull/79#discussion_r273321207

I should have noted what type parameter was for as it’s absolutely unclear. Creating this issue, so I can fix it by adding comments clarifing

Gozala commented 5 years ago

I have add comment elaborating on this in #82 if it get's merged this can be closed. If it's decided to not merge it, I'll add those comments here instead https://github.com/multiformats/js-cid/blob/63cd5f3dd87d8aa1549ef7b40093f07ab5e854f6/src/index.js.flow#L9