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

Publish typescript types #767

Open
dimaMachina opened this issue Dec 21, 2024 · 3 comments
Open

Publish typescript types #767

dimaMachina opened this issue Dec 21, 2024 · 3 comments

Comments

@dimaMachina
Copy link

I would like to use types from https://github.com/CloudCannon/pagefind/blob/main/pagefind_web_js/types/index.d.ts but @pagefind/js isn't published. Any solutions without copy pasting these types? Thank you!

@bglw
Copy link
Contributor

bglw commented Jan 19, 2025

👋 This is something I'll look at publishing soon. Ideally I want to publish the JS itself as a package (and thus the types), I have just been waiting for some sense of stability in the JS<>Wasm communication, to make the versioning slightly more lenient.

Some of the unreleased work on main does tidy up this communication, so I could probably look at releasing the JS package with the next Pagefind version.

@valadaptive
Copy link

It also seems like currently, the functions in public_search_api.ts are not included in types/index.d.ts (or indeed, any type definitions).

@bglw
Copy link
Contributor

bglw commented Jan 20, 2025

It also seems like currently, the functions in public_search_api.ts are not included in types/index.d.ts (or indeed, any type definitions).

Correct — those definition files aren't for publishing, they're for the TS itself to use, so the package will be published with generated types from the TS files

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

No branches or pull requests

3 participants