fix(utils): add init property to the return type of atomWithReset #2304
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. Latest deployment of this branch, based on commit ddef07e:
|
dai-shi
requested changes
Dec 17, 2023
src/vanilla/atom.ts
Outdated
| @@ -23,7 +23,7 @@ type Write<Args extends unknown[], Result> = ( | |||
| ...args: Args | |||
| ) => Result | |||
|
|
|||
| type WithInitialValue<Value> = { | |||
| export type WithInitialValue<Value> = { | |||
There was a problem hiding this comment.
This type is intentionally private. Please define it in atomWithReset.ts.
init property is an internal property too.
… in atomWithReset.ts
dai-shi
approved these changes
Dec 17, 2023
There was a problem hiding this comment.
As I said in #2303, using .init is not recommended in the userland code. (Technically, there can be breaking changes without notice. If this is confusing, we should probably remove WithInitialValue type.)
This change is technically valid, and helps hacks. I will merge it later when preparing the next release.
|
Let me add a commit to add a note in the source code and see how you feel. |
Love it :) |
dai-shi
changed the title
1 task
davydkov
referenced
this pull request
in likec4/likec4
Feb 7, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jotai](https://togithub.com/pmndrs/jotai) | [`^2.6.0` -> `^2.6.4`](https://renovatebot.com/diffs/npm/jotai/2.6.0/2.6.4) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pmndrs/jotai (jotai)</summary> ### [`v2.6.4`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.4) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.3...v2.6.4) Performance improvement! Check it out! ##### What's Changed - refactor: refactoring store and options type by [@​ssi02014](https://togithub.com/ssi02014) in [https://github.com/pmndrs/jotai/pull/2360](https://togithub.com/pmndrs/jotai/pull/2360) - refactor: modified Args type by [@​ssi02014](https://togithub.com/ssi02014) in [https://github.com/pmndrs/jotai/pull/2367](https://togithub.com/pmndrs/jotai/pull/2367) - Improve performance of recomputeDependents by [@​samkline](https://togithub.com/samkline) in [https://github.com/pmndrs/jotai/pull/2363](https://togithub.com/pmndrs/jotai/pull/2363) - fix(vanilla): fix unexpected cache in jotai-scope by [@​yf-yang](https://togithub.com/yf-yang) in [https://github.com/pmndrs/jotai/pull/2371](https://togithub.com/pmndrs/jotai/pull/2371) ##### New Contributors - [@​ssi02014](https://togithub.com/ssi02014) made their first contribution in [https://github.com/pmndrs/jotai/pull/2360](https://togithub.com/pmndrs/jotai/pull/2360) - [@​samkline](https://togithub.com/samkline) made their first contribution in [https://github.com/pmndrs/jotai/pull/2363](https://togithub.com/pmndrs/jotai/pull/2363) - [@​yf-yang](https://togithub.com/yf-yang) made their first contribution in [https://github.com/pmndrs/jotai/pull/2371](https://togithub.com/pmndrs/jotai/pull/2371) **Full Changelog**: pmndrs/jotai@v2.6.3...v2.6.4 ### [`v2.6.3`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.3) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.2...v2.6.3) Some improvements in core and utils 👏 #### What's Changed - fix: atoms should not remount on recalculations (with async dependencies) by [@​dmaskasky](https://togithub.com/dmaskasky) in [https://github.com/pmndrs/jotai/pull/2347](https://togithub.com/pmndrs/jotai/pull/2347) - fix(utils): atomWithReducer for jotai-scope by [@​dai-shi](https://togithub.com/dai-shi) in [https://github.com/pmndrs/jotai/pull/2351](https://togithub.com/pmndrs/jotai/pull/2351) - fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount by [@​benediktschlager](https://togithub.com/benediktschlager) in [https://github.com/pmndrs/jotai/pull/2354](https://togithub.com/pmndrs/jotai/pull/2354) - feat(vanilla): customizable atom.unstable_is by [@​dai-shi](https://togithub.com/dai-shi) in [https://github.com/pmndrs/jotai/pull/2356](https://togithub.com/pmndrs/jotai/pull/2356) #### New Contributors - [@​SpringHgui](https://togithub.com/SpringHgui) made their first contribution in [https://github.com/pmndrs/jotai/pull/2320](https://togithub.com/pmndrs/jotai/pull/2320) - [@​sakurawen](https://togithub.com/sakurawen) made their first contribution in [https://github.com/pmndrs/jotai/pull/2358](https://togithub.com/pmndrs/jotai/pull/2358) - [@​JoltCode](https://togithub.com/JoltCode) made their first contribution in [https://github.com/pmndrs/jotai/pull/2357](https://togithub.com/pmndrs/jotai/pull/2357) - [@​benediktschlager](https://togithub.com/benediktschlager) made their first contribution in [https://github.com/pmndrs/jotai/pull/2354](https://togithub.com/pmndrs/jotai/pull/2354) **Full Changelog**: pmndrs/jotai@v2.6.2...v2.6.3 ### [`v2.6.2`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.2) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.1...v2.6.2) Some improvements for atomWithStorage. Feedback is welcome. #### What's Changed - fix(vanilla): should mount once with atom creator atom by [@​nogaten](https://togithub.com/nogaten) in [https://github.com/pmndrs/jotai/pull/2319](https://togithub.com/pmndrs/jotai/pull/2319) - feat(utils): createJSONStrage options by [@​dai-shi](https://togithub.com/dai-shi) in [https://github.com/pmndrs/jotai/pull/2324](https://togithub.com/pmndrs/jotai/pull/2324) - feat(utils): add withStorageValidator by [@​dai-shi](https://togithub.com/dai-shi) in [https://github.com/pmndrs/jotai/pull/2336](https://togithub.com/pmndrs/jotai/pull/2336) #### New Contributors - [@​L-Qun](https://togithub.com/L-Qun) made their first contribution in [https://github.com/pmndrs/jotai/pull/2318](https://togithub.com/pmndrs/jotai/pull/2318) - [@​ahme-dev](https://togithub.com/ahme-dev) made their first contribution in [https://github.com/pmndrs/jotai/pull/2332](https://togithub.com/pmndrs/jotai/pull/2332) - [@​nogaten](https://togithub.com/nogaten) made their first contribution in [https://github.com/pmndrs/jotai/pull/2319](https://togithub.com/pmndrs/jotai/pull/2319) **Full Changelog**: pmndrs/jotai@v2.6.1...v2.6.2 ### [`v2.6.1`](https://togithub.com/pmndrs/jotai/releases/tag/v2.6.1) [Compare Source](https://togithub.com/pmndrs/jotai/compare/v2.6.0...v2.6.1) This version has two minor improvements for library authors. It's wonderful to see Jotai ecosystem growing. No major bugs have been reported lately. It's fairly okay to say the current version is pretty stable. #### What's Changed - fix(utils): add init property to the return type of atomWithReset by [@​jaesoekjjang](https://togithub.com/jaesoekjjang) in [https://github.com/pmndrs/jotai/pull/2304](https://togithub.com/pmndrs/jotai/pull/2304) - fix(utils): add description for the RESET symbol. by [@​MiroslavPetrik](https://togithub.com/MiroslavPetrik) in [https://github.com/pmndrs/jotai/pull/2307](https://togithub.com/pmndrs/jotai/pull/2307) #### New Contributors - [@​wherehows](https://togithub.com/wherehows) made their first contribution in [https://github.com/pmndrs/jotai/pull/2270](https://togithub.com/pmndrs/jotai/pull/2270) - [@​benson00077](https://togithub.com/benson00077) made their first contribution in [https://github.com/pmndrs/jotai/pull/2284](https://togithub.com/pmndrs/jotai/pull/2284) - [@​ioExpander](https://togithub.com/ioExpander) made their first contribution in [https://github.com/pmndrs/jotai/pull/2280](https://togithub.com/pmndrs/jotai/pull/2280) - [@​jaesoekjjang](https://togithub.com/jaesoekjjang) made their first contribution in [https://github.com/pmndrs/jotai/pull/2304](https://togithub.com/pmndrs/jotai/pull/2304) **Full Changelog**: pmndrs/jotai@v2.6.0...v2.6.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/likec4/likec4). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNzMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjE3My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
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
Fixes #2303
Summary
Changed return type of
atomWithReset(),to
Check List
yarn run prettierfor formatting code and docs