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

Is there any API documentation for this library? #1

Open
jeffcharles opened this issue Aug 12, 2020 · 7 comments
Open

Is there any API documentation for this library? #1

jeffcharles opened this issue Aug 12, 2020 · 7 comments

Comments

@jeffcharles
Copy link

I don't see any API documentation or example usage in the README or linked to in the description. API documentation would be helpful to use this library outside of a wapc context.

@autodidaddict
Copy link

Yeah the documentation has been "forthcoming" for a while now. @pkedy may be able to provide better information on the roadmap and timeline for the AssemblyScript MessagePack library.

@jeffcharles
Copy link
Author

Is the library currently working? I can try and figure it out from inspecting source code but would be good to know if it's in a working state or not first.

@autodidaddict
Copy link

It's working an in use both for waPC and for the waSCC AssemblyScript actor SDK , but the documentation for that is also mostly non-existent right now.

@chances
Copy link

chances commented Jan 11, 2021

@wapc Are you open to accepting PRs to add documentation? I could get something whipped up with typedoc pretty quickly.

@pkedy
Copy link
Member

pkedy commented Jan 11, 2021

@chances Absolutely open to PRs! Would love to see how typedoc would work here. At a minimum the README needs an example which could be derived from a waSCC/wasmCloud example or generated via the new CLI using our WIDL spec (which is also in need of documentation).

@ppedziwiatr
Copy link

Can anyone please provide some example of how to use this library in a wasm module? do I need to add anything specific in the asc configuration to make it work? or is it just a matter of adding library in a package.json and importing it in the AS code?

@JairusSW
Copy link

I'm willing to figure out some docs and update this to v0.20.x of AS

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

6 participants