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

Make docs-searchbar compatible with typescript #479

Closed
bidoubiwa opened this issue Nov 14, 2021 · 4 comments · Fixed by #686
Closed

Make docs-searchbar compatible with typescript #479

bidoubiwa opened this issue Nov 14, 2021 · 4 comments · Fixed by #686
Labels
good first issue Good for newcomers

Comments

@bidoubiwa
Copy link
Contributor

bidoubiwa commented Nov 14, 2021

For the moment when using docs-searchbar.js in an typescript environment, it raises an error because of a lack of declaration file. This can be prevented by providing a type file.

Better explanation on the issue here.

@bidoubiwa bidoubiwa added the good first issue Good for newcomers label Apr 7, 2022
@AyushK-101
Copy link
Contributor

I would like to work on this issue

@bidoubiwa
Copy link
Contributor Author

Thanks for your interest in this project 🔥 You are definitely more than welcome to open a PR for this!

We prefer not assigning people to our issues because sometimes people ask to be assigned and never come back, which discourages the real volunteers contributors from opening a PR to fix this issue.
We will accept and merge the first PR that fixes correctly and well implements the issue following our contributing guidelines.

We are looking forward to reviewing your PR 😊

@AyushK-101
Copy link
Contributor

@bidoubiwa I would like to know more about the issue, as in how can I reproduce it. From what I am getting, we can set allowJs to true in compilerOptions in tsconfig.json to run the Javascript files in typescript environment

@bidoubiwa
Copy link
Contributor Author

In some environments they need to have access to a type file. Something like index.d.ts. You can find more information on how to do this here.

An example of a repository that does this is axios which code-base is in JS but they provide a type file.

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

Successfully merging a pull request may close this issue.

2 participants