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

Document witPath option #101

Open
rylev opened this issue Apr 10, 2024 · 1 comment
Open

Document witPath option #101

rylev opened this issue Apr 10, 2024 · 1 comment

Comments

@rylev
Copy link

rylev commented Apr 10, 2024

The witPath option to the componentize function can either be a path to a single wit file or to a directory. If the path is a wit file then the wit package must not have any dependencies. Otherwise, if the path is a directory, the package's dependencies can be located in a deps directory.

This should be documented as it is not obvious that this is the behavior.

@guybedford
Copy link
Collaborator

With the type definitions now landed, there is a basic description in https://github.com/bytecodealliance/ComponentizeJS/blob/main/types.d.ts#L17. If you'd like to improve that contextual documentation with a better description, I'll gladly merge any PR.

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

2 participants