Add models namespace and constructor on client #58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update Models to be called ModelsClient, the client gives access to
models using:
```
modelsClient.models.get<T>({...})
```
The get function accepts the model name, channel name, and registration
arguments ($sync and $merge functions) in order to build and register
the model.
zknill
commented
Oct 19, 2023
zknill
commented
Oct 19, 2023
zknill
force-pushed
the
zak/COL-41-models-namespace
branch
from
6141ae5 to
d8e3018
Compare
zknill
commented
Oct 19, 2023
Require users to call the initial sync function themselves. Remove the $register function, and move the method registrations into the Model constructor. Update the docs
mschristensen
approved these changes
Oct 20, 2023
mschristensen
requested changes
Oct 20, 2023
mschristensen
approved these changes
Oct 20, 2023
README.md
Outdated
| // register the functions we defined above | ||
| await model.$register({ | ||
| // create a new model instance called 'post' by passing the sync and merge functions | ||
| const model = await modelsClient.models.get<Post>({ |
There was a problem hiding this comment.
No need for await here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update Models to be called ModelsClient, the client gives access to models using:
The get function accepts the model name, channel name, and registration arguments ($sync and $merge functions) in order to build and register the model.