Derived Stores

docs/config.json

@@ -77,10 +77,22 @@
           "label": "Classes / Store",
           "to": "reference/classes/store"
         },
+        {
+          "label": "Classes / Derived",
+          "to": "reference/classes/derived"
+        },
+        {
+          "label": "Classes / Effect",
+          "to": "reference/classes/effect"
+        },
         {
           "label": "Interfaces / StoreOptions",
           "to": "reference/interfaces/storeoptions"
         }
+        {
+          "label": "Interfaces / DerivedOptions",
+          "to": "reference/interfaces/derivedoptions"
+        }
       ],
       "frameworks": [
         {

docs/framework/angular/reference/functions/injectstore.md

@@ -5,33 +5,64 @@ title: injectStore
 
 # Function: injectStore()
 
+## injectStore(store, selector, options)
+
 ```ts
-function injectStore<TState, TSelected, TUpdater>(
+function injectStore<TState, TSelected>(
    store, 
-   selector, 
-options): Signal<TSelected>
+   selector?, 
+options?): Signal<TSelected>
 ```
 
-## Type Parameters
+### Type Parameters
 
 • **TState**
 
 • **TSelected** = `NoInfer`\<`TState`\>
 
-• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater`
+### Parameters
+
+• **store**: `Store`\<`TState`, `any`\>
+
+• **selector?**
+
+• **options?**: `CreateSignalOptions`\<`TSelected`\> & `object`
+
+### Returns
+
+`Signal`\<`TSelected`\>
+
+### Defined in
+
+[index.ts:19](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L19)
+
+## injectStore(store, selector, options)
+
+```ts
+function injectStore<TState, TSelected>(
+   store, 
+   selector?, 
+options?): Signal<TSelected>
+```
+
+### Type Parameters
+
+• **TState**
+
+• **TSelected** = `NoInfer`\<`TState`\>
 
-## Parameters
+### Parameters
 
-• **store**: `Store`\<`TState`, `TUpdater`\>
+• **store**: `Derived`\<`TState`, `any`\>
 
-• **selector** = `...`
+• **selector?**
 
-• **options**: `CreateSignalOptions`\<`TSelected`\> & `object` = `...`
+• **options?**: `CreateSignalOptions`\<`TSelected`\> & `object`
 
-## Returns
+### Returns
 
 `Signal`\<`TSelected`\>
 
-## Defined in
+### Defined in
 
-[index.ts:17](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L17)
+[index.ts:24](https://github.com/TanStack/store/blob/main/packages/angular-store/src/index.ts#L24)

docs/framework/react/reference/functions/shallow.md

@@ -25,4 +25,4 @@ function shallow<T>(objA, objB): boolean
 
 ## Defined in
 
-[index.ts:30](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L30)
+[index.ts:34](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L34)

docs/framework/react/reference/functions/usestore.md

@@ -5,28 +5,54 @@ title: useStore
 
 # Function: useStore()
 
+## useStore(store, selector)
+
 ```ts
-function useStore<TState, TSelected, TUpdater>(store, selector): TSelected
+function useStore<TState, TSelected>(store, selector?): TSelected
 ```
 
-## Type Parameters
+### Type Parameters
 
 • **TState**
 
 • **TSelected** = `NoInfer`\<`TState`\>
 
-• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater`
-
-## Parameters
+### Parameters
 
-• **store**: `Store`\<`TState`, `TUpdater`\>
+• **store**: `Store`\<`TState`, `any`\>
 
-• **selector** = `...`
+• **selector?**
 
-## Returns
+### Returns
 
 `TSelected`
 
-## Defined in
+### Defined in
 
 [index.ts:11](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L11)
+
+## useStore(store, selector)
+
+```ts
+function useStore<TState, TSelected>(store, selector?): TSelected
+```
+
+### Type Parameters
+
+• **TState**
+
+• **TSelected** = `NoInfer`\<`TState`\>
+
+### Parameters
+
+• **store**: `Derived`\<`TState`, `any`\>
+
+• **selector?**
+
+### Returns
+
+`TSelected`
+
+### Defined in
+
+[index.ts:15](https://github.com/TanStack/store/blob/main/packages/react-store/src/index.ts#L15)

docs/framework/solid/reference/functions/usestore.md

@@ -5,28 +5,54 @@ title: useStore
 
 # Function: useStore()
 
+## useStore(store, selector)
+
 ```ts
-function useStore<TState, TSelected, TUpdater>(store, selector): Accessor<TSelected>
+function useStore<TState, TSelected>(store, selector?): Accessor<TSelected>
 ```
 
-## Type Parameters
+### Type Parameters
 
 • **TState**
 
 • **TSelected** = `NoInfer`\<`TState`\>
 
-• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater`
-
-## Parameters
+### Parameters
 
-• **store**: `Store`\<`TState`, `TUpdater`\>
+• **store**: `Store`\<`TState`, `any`\>
 
-• **selector** = `...`
+• **selector?**
 
-## Returns
+### Returns
 
 `Accessor`\<`TSelected`\>
 
-## Defined in
+### Defined in
 
 [index.tsx:13](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L13)
+
+## useStore(store, selector)
+
+```ts
+function useStore<TState, TSelected>(store, selector?): Accessor<TSelected>
+```
+
+### Type Parameters
+
+• **TState**
+
+• **TSelected** = `NoInfer`\<`TState`\>
+
+### Parameters
+
+• **store**: `Derived`\<`TState`, `any`\>
+
+• **selector?**
+
+### Returns
+
+`Accessor`\<`TSelected`\>
+
+### Defined in
+
+[index.tsx:17](https://github.com/TanStack/store/blob/main/packages/solid-store/src/index.tsx#L17)

docs/framework/svelte/reference/functions/shallow.md

@@ -25,4 +25,4 @@ function shallow<T>(objA, objB): boolean
 
 ## Defined in
 
-[index.svelte.ts:39](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L39)
+[index.svelte.ts:43](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L43)

docs/framework/svelte/reference/functions/usestore.md

@@ -5,40 +5,66 @@ title: useStore
 
 # Function: useStore()
 
+## useStore(store, selector)
+
 ```ts
-function useStore<TState, TSelected, TUpdater>(store, selector): object
+function useStore<TState, TSelected>(store, selector?): object
 ```
 
-## Type Parameters
+### Type Parameters
 
 • **TState**
 
 • **TSelected** = `NoInfer`\<`TState`\>
 
-• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater`
-
-## Parameters
+### Parameters
 
-• **store**: `Store`\<`TState`, `TUpdater`\>
+• **store**: `Store`\<`TState`, `any`\>
 
-• **selector** = `...`
+• **selector?**
 
-## Returns
+### Returns
 
 `object`
 
-### current
+#### current
+
+```ts
+readonly current: TSelected;
+```
 
-#### Get Signature
+### Defined in
+
+[index.svelte.ts:10](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L10)
+
+## useStore(store, selector)
 
 ```ts
-get current(): TSelected
+function useStore<TState, TSelected>(store, selector?): object
 ```
 
-##### Returns
+### Type Parameters
 
-`TSelected`
+• **TState**
 
-## Defined in
+• **TSelected** = `NoInfer`\<`TState`\>
 
-[index.svelte.ts:10](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L10)
+### Parameters
+
+• **store**: `Derived`\<`TState`, `any`\>
+
+• **selector?**
+
+### Returns
+
+`object`
+
+#### current
+
+```ts
+readonly current: TSelected;
+```
+
+### Defined in
+
+[index.svelte.ts:14](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/index.svelte.ts#L14)

docs/framework/vue/reference/functions/shallow.md

@@ -25,4 +25,4 @@ function shallow<T>(objA, objB): boolean
 
 ## Defined in
 
-[index.ts:43](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L43)
+[index.ts:47](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L47)

docs/framework/vue/reference/functions/usestore.md

@@ -5,28 +5,54 @@ title: useStore
 
 # Function: useStore()
 
+## useStore(store, selector)
+
 ```ts
-function useStore<TState, TSelected, TUpdater>(store, selector): Readonly<Ref<TSelected>>
+function useStore<TState, TSelected>(store, selector?): Readonly<Ref<TSelected>>
 ```
 
-## Type Parameters
+### Type Parameters
 
 • **TState**
 
 • **TSelected** = `NoInfer`\<`TState`\>
 
-• **TUpdater** *extends* `AnyUpdater` = `AnyUpdater`
-
-## Parameters
+### Parameters
 
-• **store**: `Store`\<`TState`, `TUpdater`\>
+• **store**: `Store`\<`TState`, `any`\>
 
-• **selector** = `...`
+• **selector?**
 
-## Returns
+### Returns
 
 `Readonly`\<`Ref`\<`TSelected`\>\>
 
-## Defined in
+### Defined in
 
 [index.ts:12](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L12)
+
+## useStore(store, selector)
+
+```ts
+function useStore<TState, TSelected>(store, selector?): Readonly<Ref<TSelected>>
+```
+
+### Type Parameters
+
+• **TState**
+
+• **TSelected** = `NoInfer`\<`TState`\>
+
+### Parameters
+
+• **store**: `Derived`\<`TState`, `any`\>
+
+• **selector?**
+
+### Returns
+
+`Readonly`\<`Ref`\<`TSelected`\>\>
+
+### Defined in
+
+[index.ts:16](https://github.com/TanStack/store/blob/main/packages/vue-store/src/index.ts#L16)