Skip to content
Source
Sign inSign up
TanStack/store
Open History to see the last commit

useCreateAtom.md

84 lines1.4 KB

Readonly atom

function useCreateAtom<T>(getValue, options?): ReadonlyAtom<T>;

Defined in: useCreateAtom.ts:18

Creates a stable atom instance for the lifetime of the component.

Pass an initial value to create a writable atom, or a getter function to create a readonly derived atom. This hook mirrors the overloads from createAtom, but ensures the atom is only created once per mount.

Type Parameters

T

T

Parameters

getValue

(prev?) => T

options?

AtomOptions<T>

Returns

ReadonlyAtom<T>

Example

const countAtom = useCreateAtom(0)

Writable atom

function useCreateAtom<T>(initialValue, options?): Atom<T>;

Defined in: useCreateAtom.ts:22

Creates a stable atom instance for the lifetime of the component.

Pass an initial value to create a writable atom, or a getter function to create a readonly derived atom. This hook mirrors the overloads from createAtom, but ensures the atom is only created once per mount.

Type Parameters

T

T

Parameters

initialValue

T

options?

AtomOptions<T>

Returns

Atom<T>

Example

const countAtom = useCreateAtom(0)