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

docs(create-view-model): Add documentation for IViewModel #328

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

diffy0712
Copy link

@diffy0712 diffy0712 commented Mar 15, 2024

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 the type hints tooltip of the IDE. Also when jumping to the definition of the IViewModel.submit we would see no comments for it.

Changes

  • Added documentation for the IViewModel interface based on the documentation for `createViewModel' function, also adding the mobx decorator used in those cases to see from the docs, if that is an observable, bound action or not etc...
  • Reordered the properties and methods so they are in the same order as in the documentation.

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

Successfully merging this pull request may close these issues.

None yet

1 participant