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

Remove incorrect types to reduce maintenance overhead #405

Merged
merged 1 commit into from
Jan 6, 2024

Conversation

DerZade
Copy link
Contributor

@DerZade DerZade commented Sep 28, 2023

This PR removes the typescript type declarations.

As already mentioned in #342, #392 and #364, the types shipped with this package are plain incorrect. This is an issue every developer has to work around when using this package together with typescript.

I can tell that this package is basically abandoned, so I decided to remove the index.d.ts instead of patching it as #364 did.
This ensures minimal maintenance effort, while allowing other motivated developers to publish correct types in @types/flexsearch.

@ts-thomas Please take five minutes to merge and publish this so that hundreds (or even thousands) of developers do not have to invest five minutes each to work around this every time they want to install this package. (As a small incentive 🙈 I even sponsored you for this)

Thank you for the amazing package!

@ts-thomas ts-thomas merged commit 1436eff into nextapps-de:master Jan 6, 2024
@ts-thomas
Copy link
Contributor

Thanks a lot. The whole type definition thing was a desaster. My intention was that this specific part could be managed by the community, but we couldn't archive this goal. I will add a proper type definition soon like I made in the Mikado project.

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