doc: update atom-effect docs #2188
Merged
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dmaskasky
force-pushed
the
docs-atom-effect-3
branch
from
b27807b to
97dc63d
Compare
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 16f27d0:
|
- use caution when using async atom-effects - improve language on comparison with useEffect
dmaskasky
force-pushed
the
docs-atom-effect-3
branch
from
97dc63d to
16f27d0
Compare
dai-shi
approved these changes
Oct 16, 2023
| @@ -232,12 +232,14 @@ Aside from mount events, the effect runs when any of its dependencies change val | |||
| - **Async:** | |||
| For effects that return a promise, all atoms accessed with `get` prior to the returned promise resolving are added to the atom's internal dependency map. Atoms that have been watched after the promise has resolved, for instance in a `setTimeout`, are not included in the dependency map. | |||
|
|
|||
| ⚠️ Use [caution](https://github.com/jotaijs/jotai-effect/discussions/10) when using async effects | |||
There was a problem hiding this comment.
My suggestion is to drop async, but let's merge this PR for now.
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.
Related Issues or Discussions
jotaijs/jotai-effect#10
Summary
Check List
yarn run prettierfor formatting code and docs