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

Please ship TypeScript definitions #303

Open
SnarkBoojum opened this issue Nov 12, 2020 · 5 comments · May be fixed by #583
Open

Please ship TypeScript definitions #303

SnarkBoojum opened this issue Nov 12, 2020 · 5 comments · May be fixed by #583

Comments

@SnarkBoojum
Copy link

Some definitions are available here.

Thanks

@ExplodingCabbage
Copy link
Collaborator

Looks like there's a process to deprecate the DefinitelyTyped types that we should follow when we do this - see DefinitelyTyped/DefinitelyTyped#20258 for an example.

@Rednas83
Copy link

Rednas83 commented Oct 9, 2024

Any updates?

@isaachinman
Copy link

@ExplodingCabbage @tmm1 Would you accept a PR to include the types from here directly into this repo?

@ExplodingCabbage
Copy link
Collaborator

@isaachinman sure, that'd save me some work figuring out how to do that and be a great start point.

@isaachinman isaachinman linked a pull request Feb 19, 2025 that will close this issue
@isaachinman
Copy link

Spent about 15 minutes updating the rollup config to emit types based on your JavaScript codebase. Unfortunately, those declarations are completely incorrect. You'd need to either rewrite the entire repo in TS, or at least annotate via jsdoc for proper types.

Until then, I think the straightforward thing to do is basically inline the @types/diff content and just publish it from within this package.

I've opened a PR and tested it against my own consuming application.

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

Successfully merging a pull request may close this issue.

4 participants