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

Update README.md TypesScript instructions #176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

khtdr
Copy link

@khtdr khtdr commented Jul 24, 2024

The typescript instructions have a typo in them, this change makes it work for me

May be related to this:
#140

fix typescript instructions
@khtdr khtdr changed the title Update README.md Update README.md TypesScript instructions Jul 24, 2024
@IDisposable
Copy link
Member

Clarify for me, this seems to point to the original product's name... don't we want a .d.ts for this project?

@khtdr
Copy link
Author

khtdr commented Jul 24, 2024

It does no good to install the upstream types, unless you use them. The d.ts is needed, but it needs to export the ones we pulled from upstream. Ideally with whatever changes are present in this lib, but at least the original ones.

I'm not sure if I'm explaining this well. Without my change, typescript doesn't work

@khtdr
Copy link
Author

khtdr commented Jul 24, 2024

And by work, i mean pull in the right types while coding. It runs just fine if you put in the error suppressions

@IDisposable
Copy link
Member

Here's what I'm worried about... you've change it to point at the old package name, so it's not getting the types for this package. What I think I need to do is to actually generate a .d.ts for THIS package and make it available.. I've never done that... will look into it this weekned.

@khtdr
Copy link
Author

khtdr commented Jul 26, 2024

I agree that generating your own is better. What I've provided is the bare minimum, in absence of that. 👍

thanks for the package

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

Successfully merging this pull request may close these issues.

2 participants