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

[DX] Documentation example and TS Docs for the returned operation result of client-side API should be enhanced #2936

Open
taefi opened this issue Nov 28, 2024 · 0 comments · May be fixed by #3076
Labels
documentation Improvements or additions to documentation hilla Issues related to Hilla

Comments

@taefi
Copy link
Contributor

taefi commented Nov 28, 2024

When calling an method on signal instances in the TS code, an Operation object is returned containing a result promise, through which the user can subscribe for success or failure, as well as handling the errors. It seems that the followings can be enhances:

  • The TS Docs for Operation to include a short example (missing further description/example)
  • A section in the docs that briefly demonstrates how to leverage from this returned promise. (missing)
@taefi taefi added documentation Improvements or additions to documentation hilla Issues related to Hilla labels Nov 28, 2024
taefi added a commit that referenced this issue Dec 20, 2024
@taefi taefi linked a pull request Dec 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hilla Issues related to Hilla
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant