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

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

Closed
taefi opened this issue Nov 28, 2024 · 2 comments · Fixed by #3076 or vaadin/docs#4052
Closed

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

taefi opened this issue Nov 28, 2024 · 2 comments · Fixed by #3076 or vaadin/docs#4052
Labels
documentation Improvements or additions to documentation hilla Issues related to Hilla prerelease version for Hilla 24.7.0 Released with Hilla 24.6.2 Released with Hilla 24.7.0.alpha7

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
fix: clarify TS Docs for better DX
fdc7b88 
Fixes #2936
@taefi taefi mentioned this issue Dec 20, 2024
Merged
taefi added a commit to vaadin/docs that referenced this issue Jan 7, 2025
@taefi
fix: clarify Operation return type
39daf77 
Fixes vaadin/hilla#2936
@taefi taefi mentioned this issue Jan 7, 2025
Merged
taefi added a commit to vaadin/docs that referenced this issue Jan 8, 2025
@taefi
fix: clarify Operation return type
ea700ae 
Fixes vaadin/hilla#2936
vaadin-bot pushed a commit that referenced this issue Jan 13, 2025
@taefi @cromoteca @vaadin-bot
fix: clarify TS Docs for better DX (#3076)
fa046af 
* fix: clarify TS Docs for better DX

Fixes #2936

* add TS Docs example

---------

Co-authored-by: Luciano Vernaschi <luciano@vaadin.com>
cromoteca added a commit that referenced this issue Jan 13, 2025
@vaadin-bot @taefi @cromoteca
fix: clarify TS Docs for better DX (#3076) (CP: 24.6) (#3149)
5ca16e3 
fix: clarify TS Docs for better DX (#3076)

* fix: clarify TS Docs for better DX

Fixes #2936

* add TS Docs example

---------

Co-authored-by: Soroosh Taefi <taefi.soroosh@gmail.com>
Co-authored-by: Luciano Vernaschi <luciano@vaadin.com>
@vaadin-bot
Copy link
Collaborator

This ticket/PR has been released with Hilla 24.6.2.

@vaadin-bot
Copy link
Collaborator

This ticket/PR has been released with Hilla 24.7.0.alpha7 and is also targeting the upcoming stable 24.7.0 version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hilla Issues related to Hilla prerelease version for Hilla 24.7.0 Released with Hilla 24.6.2 Released with Hilla 24.7.0.alpha7
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: clarify TS Docs for better DX vaadin/hilla
fix: clarify Operation return type vaadin/docs
2 participants
@vaadin-bot @taefi