ci: apply automated fixes and generate docs

Author: autofix-ci[bot]

docs/reference/classes/ReadonlyStore.md

@@ -5,7 +5,7 @@ title: ReadonlyStore
 
 # Class: ReadonlyStore\<T\>
 
-Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59)
+Defined in: [store.ts:69](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L69)
 
 ## Type Parameters
 
@@ -25,7 +25,7 @@ Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/s
 new ReadonlyStore<T>(getValue): ReadonlyStore<T>;
 ```
 
-Defined in: [store.ts:64](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L64)
+Defined in: [store.ts:74](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L74)
 
 #### Parameters
 
@@ -43,7 +43,7 @@ Defined in: [store.ts:64](https://github.com/TanStack/store/blob/main/packages/s
 new ReadonlyStore<T>(initialValue): ReadonlyStore<T>;
 ```
 
-Defined in: [store.ts:65](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L65)
+Defined in: [store.ts:75](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L75)
 
 #### Parameters
 
@@ -65,7 +65,7 @@ Defined in: [store.ts:65](https://github.com/TanStack/store/blob/main/packages/s
 get state(): T;
 ```
 
-Defined in: [store.ts:73](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L73)
+Defined in: [store.ts:83](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L83)
 
 ##### Returns
 
@@ -85,7 +85,7 @@ Omit.state
 get(): T;
 ```
 
-Defined in: [store.ts:76](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L76)
+Defined in: [store.ts:86](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L86)
 
 #### Returns
 
@@ -105,7 +105,7 @@ Omit.get
 subscribe(observerOrFn): Subscription;
 ```
 
-Defined in: [store.ts:79](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L79)
+Defined in: [store.ts:89](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L89)
 
 #### Parameters
 
@@ -122,3 +122,40 @@ Defined in: [store.ts:79](https://github.com/TanStack/store/blob/main/packages/s
 ```ts
 Omit.subscribe
 ```
+
+***
+
+### whileWatched()
+
+```ts
+whileWatched(effect): () => void;
+```
+
+Defined in: [store.ts:100](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L100)
+
+`effect` will be called while the atom is watched. `effect` may return a
+cleanup function, which will be called when the atom is unwatched.
+
+Returns a `stop` function which cancels the listener.
+
+#### Parameters
+
+##### effect
+
+[`WatchedEffect`](../type-aliases/WatchedEffect.md)
+
+#### Returns
+
+```ts
+(): void;
+```
+
+##### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+Omit.whileWatched
+```

docs/reference/classes/Store.md

@@ -5,7 +5,7 @@ title: Store
 
 # Class: Store\<T, TActions\>
 
-Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15)
+Defined in: [store.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L16)
 
 ## Type Parameters
 
@@ -25,7 +25,7 @@ Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/s
 new Store<T, TActions>(getValue): Store<T, TActions>;
 ```
 
-Defined in: [store.ts:18](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L18)
+Defined in: [store.ts:19](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L19)
 
 #### Parameters
 
@@ -43,7 +43,7 @@ Defined in: [store.ts:18](https://github.com/TanStack/store/blob/main/packages/s
 new Store<T, TActions>(initialValue): Store<T, TActions>;
 ```
 
-Defined in: [store.ts:19](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L19)
+Defined in: [store.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L20)
 
 #### Parameters
 
@@ -61,7 +61,7 @@ Defined in: [store.ts:19](https://github.com/TanStack/store/blob/main/packages/s
 new Store<T, TActions>(initialValue, actionsFactory): Store<T, TActions>;
 ```
 
-Defined in: [store.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L20)
+Defined in: [store.ts:21](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L21)
 
 #### Parameters
 
@@ -85,7 +85,7 @@ Defined in: [store.ts:20](https://github.com/TanStack/store/blob/main/packages/s
 readonly actions: TActions;
 ```
 
-Defined in: [store.ts:17](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L17)
+Defined in: [store.ts:18](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L18)
 
 ## Accessors
 
@@ -97,7 +97,7 @@ Defined in: [store.ts:17](https://github.com/TanStack/store/blob/main/packages/s
 get state(): T;
 ```
 
-Defined in: [store.ts:46](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L46)
+Defined in: [store.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L47)
 
 ##### Returns
 
@@ -111,7 +111,7 @@ Defined in: [store.ts:46](https://github.com/TanStack/store/blob/main/packages/s
 get(): T;
 ```
 
-Defined in: [store.ts:49](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L49)
+Defined in: [store.ts:50](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L50)
 
 #### Returns
 
@@ -125,7 +125,7 @@ Defined in: [store.ts:49](https://github.com/TanStack/store/blob/main/packages/s
 setState(updater): void;
 ```
 
-Defined in: [store.ts:43](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L43)
+Defined in: [store.ts:44](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L44)
 
 #### Parameters
 
@@ -145,7 +145,7 @@ Defined in: [store.ts:43](https://github.com/TanStack/store/blob/main/packages/s
 subscribe(observerOrFn): Subscription;
 ```
 
-Defined in: [store.ts:52](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L52)
+Defined in: [store.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L53)
 
 #### Parameters
 
@@ -156,3 +156,34 @@ Defined in: [store.ts:52](https://github.com/TanStack/store/blob/main/packages/s
 #### Returns
 
 [`Subscription`](../interfaces/Subscription.md)
+
+***
+
+### whileWatched()
+
+```ts
+whileWatched(effect): () => void;
+```
+
+Defined in: [store.ts:64](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L64)
+
+`effect` will be called while the atom is watched. `effect` may return a
+cleanup function, which will be called when the atom is unwatched.
+
+Returns a `stop` function which cancels the listener.
+
+#### Parameters
+
+##### effect
+
+[`WatchedEffect`](../type-aliases/WatchedEffect.md)
+
+#### Returns
+
+```ts
+(): void;
+```
+
+##### Returns
+
+`void`

docs/reference/functions/batch.md

@@ -9,7 +9,7 @@ title: batch
 function batch(fn): void;
 ```
 
-Defined in: [atom.ts:62](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L62)
+Defined in: [atom.ts:94](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L94)
 
 ## Parameters
 

docs/reference/functions/createAsyncAtom.md

@@ -9,7 +9,7 @@ title: createAsyncAtom
 function createAsyncAtom<T>(getValue, options?): ReadonlyAtom<AsyncAtomState<T, unknown>>;
 ```
 
-Defined in: [atom.ts:100](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L100)
+Defined in: [atom.ts:132](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L132)
 
 ## Type Parameters
 

docs/reference/functions/createAtom.md

@@ -11,7 +11,7 @@ title: createAtom
 function createAtom<T>(getValue, options?): ReadonlyAtom<T>;
 ```
 
-Defined in: [atom.ts:138](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L138)
+Defined in: [atom.ts:207](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L207)
 
 ### Type Parameters
 
@@ -39,7 +39,7 @@ Defined in: [atom.ts:138](https://github.com/TanStack/store/blob/main/packages/s
 function createAtom<T>(initialValue, options?): Atom<T>;
 ```
 
-Defined in: [atom.ts:142](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L142)
+Defined in: [atom.ts:211](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L211)
 
 ### Type Parameters
 

docs/reference/functions/createExternalStoreAtom.md

@@ -0,0 +1,59 @@
+---
+id: createExternalStoreAtom
+title: createExternalStoreAtom
+---
+
+# Function: createExternalStoreAtom()
+
+```ts
+function createExternalStoreAtom<T>(
+   getSnapshot, 
+   subscribe, 
+options?): ReadonlyAtom<T>;
+```
+
+Defined in: [atom.ts:191](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L191)
+
+Like React.useSyncExternalStore: pulls external state into an atom.
+This can be used for interoperating with other state management libraries.
+
+```ts
+import * as redux from "redux"
+
+const reduxStore = redux.createStore((state: number, action: number) => state + action, 0)
+const atom = createExternalStoreAtom(reduxStore.getState, reduxStore.subscribe)
+
+const timesTwo = createAtom(() => atom.get() * 2)
+timesTwo.subscribe((value) => {
+  console.log('timesTwo: ', value)
+})
+
+reduxStore.dispatch(1)
+// timesTwo: 2
+reduxStore.dispatch(1)
+// timesTwo: 4
+```
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### getSnapshot
+
+() => `T`
+
+### subscribe
+
+(`onStoreChange`) => () => `void`
+
+### options?
+
+[`AtomOptions`](../interfaces/AtomOptions.md)\<`T`\>
+
+## Returns
+
+[`ReadonlyAtom`](../interfaces/ReadonlyAtom.md)\<`T`\>

docs/reference/functions/createStore.md

@@ -11,7 +11,7 @@ title: createStore
 function createStore<T>(getValue): ReadonlyStore<T>;
 ```
 
-Defined in: [store.ts:86](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L86)
+Defined in: [store.ts:105](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L105)
 
 ### Type Parameters
 
@@ -35,7 +35,7 @@ Defined in: [store.ts:86](https://github.com/TanStack/store/blob/main/packages/s
 function createStore<T>(initialValue): Store<T>;
 ```
 
-Defined in: [store.ts:89](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L89)
+Defined in: [store.ts:108](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L108)
 
 ### Type Parameters
 
@@ -59,7 +59,7 @@ Defined in: [store.ts:89](https://github.com/TanStack/store/blob/main/packages/s
 function createStore<T, TActions>(initialValue, actions): Store<T, TActions>;
 ```
 
-Defined in: [store.ts:90](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L90)
+Defined in: [store.ts:109](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L109)
 
 ### Type Parameters
 

docs/reference/functions/flush.md

@@ -9,7 +9,7 @@ title: flush
 function flush(): void;
 ```
 
-Defined in: [atom.ts:81](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L81)
+Defined in: [atom.ts:113](https://github.com/TanStack/store/blob/main/packages/store/src/atom.ts#L113)
 
 ## Returns
 

docs/reference/index.md

@@ -31,12 +31,14 @@ title: "@tanstack/store"
 - [StoreAction](type-aliases/StoreAction.md)
 - [StoreActionMap](type-aliases/StoreActionMap.md)
 - [StoreActionsFactory](type-aliases/StoreActionsFactory.md)
+- [WatchedEffect](type-aliases/WatchedEffect.md)
 
 ## Functions
 
 - [batch](functions/batch.md)
 - [createAsyncAtom](functions/createAsyncAtom.md)
 - [createAtom](functions/createAtom.md)
+- [createExternalStoreAtom](functions/createExternalStoreAtom.md)
 - [createStore](functions/createStore.md)
 - [flush](functions/flush.md)
 - [shallow](functions/shallow.md)