datavis-tech / graph-data-structure

A graph data structure with topological sort and shortest path algorithms.
MIT License
249 stars 46 forks source link

Feature request: Add typings for methods #24

Closed yashmahalwal closed 4 years ago

yashmahalwal commented 4 years ago

I needed a simple library that implemented Graph DS. Other libraries that I came across were either too basic or were an overkill with visualisation tools and so on. I have been able to integrate the library into my code base but a constant pain point is lack of typings.

For now, I work with //@ts-ignore. But I believe that adding typings would help in seamless integration in scalable code bases.

curran commented 4 years ago

PRs welcome!

yashmahalwal commented 4 years ago

@curran I had a bit of time on my hand today and I migrated the codebase under this PR. Please review the changes.

yashmahalwal commented 4 years ago

It was really awesome of you to merge the PR. I updated the package in my project today. The current version is 1.10.0 . But no typedefs were shipped with the npm package. Maybe something with the .npmignore? That is because you have a files field in the package.json which I overlooked. You would need to add index.d.ts to it ; )

PS: the package.json on github still points to 1.9.0. Maybe you did not commit after releasing?

curran commented 4 years ago

@yashmahalwal Thanks for the notes! I will clean this up.

curran commented 4 years ago

Addressed these issues and released in https://github.com/datavis-tech/graph-data-structure/releases/tag/v1.12.0 .

Please give this version a try. Thanks!

yashmahalwal commented 4 years ago

Yeah that fixes stuff (y)

curran commented 4 years ago

Hooray!