chore: adding more in depth docs for main features#197
Open
enyelsequeira wants to merge 1 commit intoTanStack:mainfrom
Open
chore: adding more in depth docs for main features#197enyelsequeira wants to merge 1 commit intoTanStack:mainfrom
enyelsequeira wants to merge 1 commit intoTanStack:mainfrom
Conversation
| id: core-effect | ||
| --- | ||
|
|
||
| # Effect Documentation |
There was a problem hiding this comment.
Hi, not a maintainer, but just something I think is really important to include in the docs
mount() must be run before the effect will do anything, in addition, mount returns an unmount function which can be used to remove the effect, exactly like you would with the cleanup function in something like useEffect
ViewableGravy
approved these changes
Jun 7, 2025
ViewableGravy
left a comment
ViewableGravy
left a comment
There was a problem hiding this comment.
Would love it if we could get this into the docs, since having only the examples for documentation is a bit frustrating
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changelog
I have added a more in depth documentation for each concept
please do let me know if my understanding is correct or if i have something wrong
I have decided to add bathc/store together since they kind of go together
Thank you
@KevinVandy @crutchcorn