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.

Sign up for GitHub

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

Jump to bottom

Provide examples of API usage in https://docs.webxdc.org/spec.html #60

Open
link2xt opened this issue Oct 9, 2023 · 2 comments · May be fixed by #82
Open

Provide examples of API usage in https://docs.webxdc.org/spec.html #60

link2xt opened this issue Oct 9, 2023 · 2 comments · May be fixed by #82

Comments

@link2xt
Copy link
Contributor

link2xt commented Oct 9, 2023

Especially for sendUpdate and setUpdateListener.
@WofWca
Copy link
Contributor

WofWca commented Oct 9, 2023

Hmm good point. Wouldn't an example app suffice though? Or I guess you'd want to see an example beside the spec of the API.

@link2xt
Copy link
Contributor Author

link2xt commented Oct 9, 2023 •
edited
Loading

Examples are already provided for sendToChat and importFiles. sendUpdate and setUpdateListener are arguably more important, so they need inline examples too.

@hpk42 hpk42 transferred this issue from webxdc/webxdc_docs Jan 31, 2024
@WofWca WofWca self-assigned this Jul 11, 2024
WofWca added a commit that referenced this issue Jul 13, 2024
@WofWca
add examples for sendUpdate, setUpdateListener
f85248a 
Closes #60
@WofWca WofWca linked a pull request Jul 13, 2024 that will close this issue
Open
WofWca added a commit that referenced this issue Jul 13, 2024
@WofWca
add examples for sendUpdate, setUpdateListener
40ac2ef 
Closes #60

Some might say that the setUpdateListener example is too convoluted,
but you can't really showcase the usage of `serial`
without this much code.
Plus, a briefer example is already shown in `sendUpdate()` docs.
WofWca added a commit that referenced this issue Jul 13, 2024
@WofWca
add examples for sendUpdate, setUpdateListener
f9a7c9a 
Closes #60

Some might say that the setUpdateListener example is too convoluted,
but you can't really showcase the usage of `serial`
without this much code.
Plus, a briefer example is already shown in `sendUpdate()` docs.

The code has been tested with the `webxdc-dev` tool,
and (mostly) fomatted with Prettier.
@WofWca WofWca removed their assignment Jul 13, 2024
WofWca added a commit that referenced this issue Jul 14, 2024
@WofWca
add examples for sendUpdate, setUpdateListener
a394d7a 
Closes #60

Some might say that the setUpdateListener example is too convoluted,
but you can't really showcase the usage of `serial`
without this much code.
Plus, a briefer example is already shown in `sendUpdate()` docs.

The code has been tested with the `webxdc-dev` tool,
and (mostly) fomatted with Prettier.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add examples for sendUpdate, setUpdateListener webxdc/website
2 participants
@link2xt @WofWca