fix(utils): add init property to the return type of atomWithReset #2304

jaesoekjjang · 2023-12-17T12:33:39Z

Related Issues or Discussions

Summary

Changed return type of atomWithReset(),

return anAtom as WritableAtom<Value, [Update], void>

to

return anAtom as WritableAtom<Value, [Update], void> & WithInitialValue<Value>

Check List

yarn run prettier for formatting code and docs

vercel · 2023-12-17T12:33:42Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
jotai	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 28, 2023 2:58pm

codesandbox-ci · 2023-12-17T12:34:10Z

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:

Sandbox	Source
React	Configuration
React TypeScript	Configuration
React Browserify	Configuration
React Snowpack	Configuration
Next.js	Configuration
Next.js with custom Babel config	Configuration
React with custom Babel config	Configuration

dai-shi

Thanks for working on it.

dai-shi · 2023-12-17T12:58:37Z

src/vanilla/atom.ts

@@ -23,7 +23,7 @@ type Write<Args extends unknown[], Result> = (
  ...args: Args
 ) => Result

-type WithInitialValue<Value> = {
+export type WithInitialValue<Value> = {


This type is intentionally private. Please define it in atomWithReset.ts.
init property is an internal property too.

… in atomWithReset.ts

dai-shi

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.

dai-shi · 2023-12-17T22:20:40Z

Let me add a commit to add a note in the source code and see how you feel.

jaesoekjjang · 2023-12-17T23:15:06Z

Let me add a commit to add a note in the source code and see how you feel.

Love it :)

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](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) | [![age](https://developer.mend.io/api/mc/badges/age/npm/jotai/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/jotai/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/jotai/2.6.0/2.6.4?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/jotai/2.6.0/2.6.4?slim=true)](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 [pmndrs/jotai#2360 - refactor: modified Args type by [@ssi02014](https://togithub.com/ssi02014) in [pmndrs/jotai#2367 - Improve performance of recomputeDependents by [@samkline](https://togithub.com/samkline) in [pmndrs/jotai#2363 - fix(vanilla): fix unexpected cache in jotai-scope by [@yf-yang](https://togithub.com/yf-yang) in [pmndrs/jotai#2371 ##### New Contributors - [@ssi02014](https://togithub.com/ssi02014) made their first contribution in [pmndrs/jotai#2360 - [@samkline](https://togithub.com/samkline) made their first contribution in [pmndrs/jotai#2363 - [@yf-yang](https://togithub.com/yf-yang) made their first contribution in [pmndrs/jotai#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 [pmndrs/jotai#2347 - fix(utils): atomWithReducer for jotai-scope by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2351 - fix(utils/atomWithStorage): defaultStorage with disabled local storage crashes on mount by [@benediktschlager](https://togithub.com/benediktschlager) in [pmndrs/jotai#2354 - feat(vanilla): customizable atom.unstable_is by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2356 #### New Contributors - [@SpringHgui](https://togithub.com/SpringHgui) made their first contribution in [pmndrs/jotai#2320 - [@sakurawen](https://togithub.com/sakurawen) made their first contribution in [pmndrs/jotai#2358 - [@JoltCode](https://togithub.com/JoltCode) made their first contribution in [pmndrs/jotai#2357 - [@benediktschlager](https://togithub.com/benediktschlager) made their first contribution in [pmndrs/jotai#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 [pmndrs/jotai#2319 - feat(utils): createJSONStrage options by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2324 - feat(utils): add withStorageValidator by [@dai-shi](https://togithub.com/dai-shi) in [pmndrs/jotai#2336 #### New Contributors - [@L-Qun](https://togithub.com/L-Qun) made their first contribution in [pmndrs/jotai#2318 - [@ahme-dev](https://togithub.com/ahme-dev) made their first contribution in [pmndrs/jotai#2332 - [@nogaten](https://togithub.com/nogaten) made their first contribution in [pmndrs/jotai#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 [pmndrs/jotai#2304 - fix(utils): add description for the RESET symbol. by [@MiroslavPetrik](https://togithub.com/MiroslavPetrik) in [pmndrs/jotai#2307 #### New Contributors - [@wherehows](https://togithub.com/wherehows) made their first contribution in [pmndrs/jotai#2270 - [@benson00077](https://togithub.com/benson00077) made their first contribution in [pmndrs/jotai#2284 - [@ioExpander](https://togithub.com/ioExpander) made their first contribution in [pmndrs/jotai#2280 - [@jaesoekjjang](https://togithub.com/jaesoekjjang) made their first contribution in [pmndrs/jotai#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. --- - [ ] 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).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix: add init property to the return type of atomWithReset

99c5e71

vercel bot deployed to Preview December 17, 2023 12:34 View deployment

dai-shi requested changes Dec 17, 2023

View reviewed changes

fix: modify to not export WithInitialValue from atom.ts, re define it…

2af6ed6

… in atomWithReset.ts

vercel bot deployed to Preview December 17, 2023 15:03 View deployment

jaesoekjjang requested a review from dai-shi December 17, 2023 15:03

dai-shi approved these changes Dec 17, 2023

View reviewed changes

add comments

dcd853a

vercel bot deployed to Preview December 17, 2023 22:24 View deployment

dai-shi added this to the v2.6.1 milestone Dec 28, 2023

Merge branch 'main' into fix/atom-with-reset-type

ddef07e

vercel bot deployed to Preview December 28, 2023 14:58 View deployment

dai-shi changed the title ~~fix: add init property to the return type of atomWithReset~~ fix(utils): add init property to the return type of atomWithReset Dec 28, 2023

dai-shi merged commit e986e63 into pmndrs:main Dec 28, 2023
33 checks passed

dai-shi mentioned this pull request Jan 8, 2024

fix(utils): add description for the RESET symbol. #2307

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(utils): add init property to the return type of atomWithReset #2304

fix(utils): add init property to the return type of atomWithReset #2304

jaesoekjjang commented Dec 17, 2023 •

edited

vercel bot commented Dec 17, 2023 •

edited

codesandbox-ci bot commented Dec 17, 2023 •

edited

dai-shi left a comment

dai-shi Dec 17, 2023

dai-shi left a comment

dai-shi commented Dec 17, 2023

jaesoekjjang commented Dec 17, 2023

fix(utils): add init property to the return type of atomWithReset #2304

fix(utils): add init property to the return type of atomWithReset #2304

Conversation

jaesoekjjang commented Dec 17, 2023 • edited

Related Issues or Discussions

Summary

Check List

vercel bot commented Dec 17, 2023 • edited

codesandbox-ci bot commented Dec 17, 2023 • edited

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi Dec 17, 2023

Choose a reason for hiding this comment

dai-shi left a comment

Choose a reason for hiding this comment

dai-shi commented Dec 17, 2023

jaesoekjjang commented Dec 17, 2023

jaesoekjjang commented Dec 17, 2023 •

edited

vercel bot commented Dec 17, 2023 •

edited

codesandbox-ci bot commented Dec 17, 2023 •

edited