Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: rename initState to callback in atom overload #822

Open
wants to merge 1 commit into
base: v3
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/core/src/atom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ function onCall(this: Action, cb: Fn): Unsubscribe {
})
}

export function atom<T>(initState: (ctx: CtxSpy) => T, name?: string): Atom<T>
export function atom<T>(callback: (ctx: CtxSpy) => T, name?: string): Atom<T>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here are my options:

  • reducer, because the second argument is the previous state
  • computer, because when we pass a function we turn an atom into a computed atom

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

computed is the right name

export function atom<T>(initState: T, name?: string): AtomMut<T>
export function atom<T>(
initState: T | ((ctx: CtxSpy) => T),
Expand Down