fix(types): add undefined initial value to Atom definition - #2668
Merged
Conversation
|
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. |
dai-shi
reviewed
Jul 20, 2024
Comment on lines
+79
to
+81
| export function atom<Value = undefined>( | ||
| read: Read<Value | undefined>, | ||
| ): Atom<Value | undefined> |
Member
There was a problem hiding this comment.
Hmm, I was expecting something like this:
Suggested change
| export function atom<Value = undefined>( | |
| read: Read<Value | undefined>, | |
| ): Atom<Value | undefined> | |
| export function atom<Value>(): PrimitiveAtom<Value | undefined> |
Contributor
Author
There was a problem hiding this comment.
This works but, in /src/vanilla/atom.ts, I get
This overload signature is not compatible with its implementation signature.ts(2394)
atom.ts(92, 17): The implementation signature is declared here.The signature (parameter) needs to be added.
Member
There was a problem hiding this comment.
Yeah, let's do that. Just make it optional?
Contributor
Author
There was a problem hiding this comment.
Done, I used the primitive definition
Contributor
Author
|
Does it also need a change like this? // write-only derived atom
export function atom<Value, Args extends unknown[], Result>(
- initialValue: Value,
+ initialValue?: Value,
write: Write<Args, Result>,
-): WritableAtom<Value, Args, Result> & WithInitialValue<Value>
+): WritableAtom<Value | undefined, Args, Result> & WithInitialValue<Value | undefined> |
Member
|
No, I think it should be explicit, and also TS doesn't allow it. |
dai-shi
reviewed
Jul 20, 2024
Comment on lines
+84
to
+87
| // primitive atom | ||
| export function atom<Value>( | ||
| initialValue: Value, | ||
| ): PrimitiveAtom<Value> & WithInitialValue<Value> | ||
| initialValue?: Value, | ||
| ): PrimitiveAtom<Value | undefined> & WithInitialValue<Value | undefined> |
Member
There was a problem hiding this comment.
No, it's looks bad. We need overloads.
// primitive atom without default value
export function atom<Value>(): PrimitiveAtom<Value | undefined> & WithInitialValue<Value | undefined>
// primitive atom
export function atom<Value>(
initialValue: Value,
): PrimitiveAtom<Value> & WithInitialValue<Value>
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
dai-shi
requested changes
Jul 20, 2024
dai-shi
left a comment
dai-shi
left a comment
Member
There was a problem hiding this comment.
Sorry if it's confusing, but do not change existing public types. Only add a new overload type and possibly fix our type in the implementation (which is not public).
| // Do not depend on it as it can change without notice. | ||
| type WithInitialValue<Value> = { | ||
| init: Value | ||
| init: Value | undefined |
Comment on lines
+89
to
+92
| // primitive atom without default value | ||
| export function atom<Value>(): PrimitiveAtom<Value> & WithInitialValue<Value> | ||
|
|
Member
There was a problem hiding this comment.
Just for preference, I would like to have it before // primitive atom.
Contributor
Author
|
Done |
|
| Playground | Link |
|---|---|
| React demo | https://livecodes.io?x=id/2YMSGQ3UN |
See documentations for usage instructions.
dai-shi
reviewed
Jul 20, 2024
dai-shi
left a comment
dai-shi
left a comment
Member
There was a problem hiding this comment.
The code looks good to me.
Can you add some tests?
Contributor
Author
|
Done |
dai-shi
reviewed
Jul 20, 2024
|
|
||
| it('creates atoms', () => { | ||
| // primitive atom without initial value | ||
| const undefinedAtom = atom() |
Member
There was a problem hiding this comment.
I'm sorry, but I didn't mean this test.
Please revert it and add "type" tests in tests/vanilla/types.test.tsx.
Member
|
@rtritto A friendly reminder
|
Contributor
Author
|
@dai-shi I need some help |
Member
|
Sure, but for which one? Let's first focus on the first one. |
Contributor
Author
|
It's related to |
Member
|
Please add this and if you have more ideas, please add them. diff --git a/tests/vanilla/types.test.tsx b/tests/vanilla/types.test.tsx
index e0744b8..3c89725 100644
--- a/tests/vanilla/types.test.tsx
+++ b/tests/vanilla/types.test.tsx
@@ -1,4 +1,5 @@
import { expectType } from 'ts-expect'
+import type { TypeOf } from 'ts-expect'
import { it } from 'vitest'
import { atom } from 'jotai/vanilla'
import type {
@@ -15,6 +16,15 @@ it('atom() should return the correct types', () => {
// primitive atom
const primitiveAtom = atom(0)
expectType<PrimitiveAtom<number>>(primitiveAtom)
+ expectType<TypeOf<PrimitiveAtom<number>, typeof primitiveAtom>>(true)
+ expectType<TypeOf<PrimitiveAtom<number | undefined>, typeof primitiveAtom>>(
+ false,
+ )
+
+ // primitive atom without initial value
+ const primitiveWithoutInitialAtom = atom<number | undefined>()
+ expectType<PrimitiveAtom<number | undefined>>(primitiveWithoutInitialAtom)
+ expectType<PrimitiveAtom<undefined>>(atom())
// read-only derived atom
const readonlyDerivedAtom = atom((get) => get(primitiveAtom) * 2) |
Contributor
Author
|
Done (no other ideas) |
dai-shi
approved these changes
Jul 23, 2024
dai-shi
left a comment
dai-shi
left a comment
Member
There was a problem hiding this comment.
LGTM
Thanks for your contribution.
Member
|
Size Change: 0 B Total Size: 87 kB ℹ️ View Unchanged
|
dai-shi
changed the title
This was referenced Sep 17, 2024
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.
Related Bug Reports or Discussions
Discussion #2667
Fixes #2666
Check List
pnpm run prettierfor formatting code and docs