Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance TypeScript types to leverage the true power of typechecking and intellisense #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vekexasia
Copy link

Hello,

I noticed the library is written in TypeScript and it provides proper typings but it does not harvest the full potential of TS when it comes to intellisense and type checking.

As a matter of fact I wanted to do this cause I had one typo in my struct and it took me 2+ hours to find a mispelled key. This could've be avoided with this patch. Let me show what i mean

Untitled.mov

As shown in the video the with this patch the developer should be able to get the proper code completion (from TS service) as well as typechecking (as shown in the last segment of the video).

This patch also tackles the encode method making sure the developer provides the correct object to encode. Ex:

image

Working on the codebase i noticed other stuff i'd like to enhance but i'm not sure if pull requests are welcome...

@jordaaash
Copy link
Collaborator

Thanks! PRs are definitely welcome, I'll review this.

@vekexasia
Copy link
Author

you're welcome @jordaaash :)

@vekexasia
Copy link
Author

Hey @jordaaash any news on this by any chance?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants