docs: add docs for bunja #2938
Merged
docs: add docs for bunja #2938
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 ↗︎
|
|
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. |
commit: |
|
| Playground | Link |
|---|---|
| React demo | https://livecodes.io?x=id/GCVJBDLWZ |
See documentations for usage instructions.
dai-shi
requested changes
Jan 16, 2025
There was a problem hiding this comment.
Please add a new library under https://github.com/pmndrs/jotai/tree/main/docs/third-party.
dai-shi
reviewed
Jan 16, 2025
docs/third-party/bunja.mdx
Outdated
|
|
||
| If you want to manage a state with a broad lifetime and another state with a narrower lifetime, you can create a (narrower) bunja that depends on a (broader) bunja. | ||
|
|
||
| For example, you can think of a bunja that manages the WebSocket connection and disconnection, and another bunja that subscribes to a specific resource over the connected WebSocket. |
There was a problem hiding this comment.
Would it be possible to provide a simpler example to show the dependency case in this second section?
There was a problem hiding this comment.
Yes, replaced it with a modal screen example. 9ffff05
dai-shi
approved these changes
Jan 17, 2025
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.
Summary
Bunja is new library like Bunshi but provides more guarantee about instance lifetime.
Check List
pnpm run fix:formatfor formatting code and docs