Open History to see the last commit
1---
2id: useAtom
3title: useAtom
4---
5β
6```ts
7function useAtom<TValue>(atom, options?): [Readonly<Ref<TValue, TValue>>, (fn) => void & (value) => void];
8```
9β
10Defined in: node\_modules/.pnpm/@tanstack+vue-store@0.11.1\_vue@3.6.0-rc.9\_typescript@6.0.3\_/node\_modules/@tanstack/vue-store/dist/useAtom.d.ts:20
11β
12Returns the current atom ref together with a setter.
13β
14Use this when a component needs to both read and update the same writable
15atom.
16β
17## Type Parameters
18β
19### TValue
20β
21`TValue`
22β
23## Parameters
24β
25### atom
26β
27[`Atom`](../interfaces/Atom.md)\<`TValue`\>
28β
29### options?
30β
31[`UseSelectorOptions`](../interfaces/UseSelectorOptions.md)\<`TValue`\>
32β
33## Returns
34β
35\[`Readonly`\<`Ref`\<`TValue`, `TValue`\>\>, (`fn`) => `void` & (`value`) => `void`\]
36β
37## Example
38β
39```ts
40const [count, setCount] = useAtom(countAtom)
41β
42setCount((prev) => prev + 1)
43console.log(count.value)
44```