docs(create-view-model): Add documentation for IViewModel #328
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Intent
Currently for ViewModel the documentation is only on the
createViewModel
function, which describes the functionality and the IViewModel interface nicely, but when working with the IViewModel you usually interact with the interface and not the factory function, so we loose the written documentation on that.For example: if we need to check the documentation for
.submit
we would get no comments in thetype hints
tooltip of the IDE. Also when jumping to the definition of theIViewModel.submit
we would see no comments for it.Changes