From 57d202582cc059c8bb7eea599a437a9ec71b438c Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Thu, 10 Sep 2026 12:49:06 +0200 Subject: [PATCH 1/5] docs: remove duplicate page headings --- .../framework/angular/reference/functions/createStoreContext.md | 2 -- docs/framework/angular/reference/functions/injectAtom.md | 2 -- docs/framework/angular/reference/functions/injectSelector.md | 2 -- docs/framework/angular/reference/functions/injectStore-1.md | 2 -- docs/framework/angular/reference/functions/injectStore.md | 2 -- docs/framework/angular/reference/index.md | 2 -- .../angular/reference/interfaces/InjectSelectorOptions.md | 2 -- .../angular/reference/interfaces/WritableAtomSignal.md | 2 -- .../framework/angular/reference/type-aliases/SelectionSource.md | 2 -- docs/framework/octane/reference/functions/createStoreContext.md | 2 -- docs/framework/octane/reference/functions/useAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateStore.md | 2 -- docs/framework/octane/reference/functions/useSelector.md | 2 -- docs/framework/octane/reference/index.md | 2 -- .../framework/octane/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/preact/reference/functions/createStoreContext.md | 2 -- docs/framework/preact/reference/functions/useAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateStore.md | 2 -- docs/framework/preact/reference/functions/useSelector.md | 2 -- docs/framework/preact/reference/functions/useStore-1.md | 2 -- docs/framework/preact/reference/functions/useStore.md | 2 -- docs/framework/preact/reference/index.md | 2 -- .../framework/preact/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/react/reference/functions/createStoreContext.md | 2 -- docs/framework/react/reference/functions/useAtom.md | 2 -- docs/framework/react/reference/functions/useCreateAtom.md | 2 -- docs/framework/react/reference/functions/useCreateStore.md | 2 -- docs/framework/react/reference/functions/useSelector.md | 2 -- docs/framework/react/reference/functions/useStore-1.md | 2 -- docs/framework/react/reference/functions/useStore.md | 2 -- docs/framework/react/reference/index.md | 2 -- docs/framework/react/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/solid/reference/functions/createStoreContext.md | 2 -- docs/framework/solid/reference/functions/useAtom.md | 2 -- docs/framework/solid/reference/functions/useSelector.md | 2 -- docs/framework/solid/reference/functions/useStore-1.md | 2 -- docs/framework/solid/reference/functions/useStore.md | 2 -- docs/framework/solid/reference/index.md | 2 -- docs/framework/solid/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/svelte/reference/functions/useAtom.md | 2 -- docs/framework/svelte/reference/functions/useSelector.md | 2 -- docs/framework/svelte/reference/functions/useStore-1.md | 2 -- docs/framework/svelte/reference/functions/useStore.md | 2 -- docs/framework/svelte/reference/index.md | 2 -- .../framework/svelte/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/vue/reference/functions/useAtom.md | 2 -- docs/framework/vue/reference/functions/useSelector.md | 2 -- docs/framework/vue/reference/functions/useStore-1.md | 2 -- docs/framework/vue/reference/functions/useStore.md | 2 -- docs/framework/vue/reference/index.md | 2 -- docs/framework/vue/reference/interfaces/UseSelectorOptions.md | 2 -- docs/reference/classes/ReadonlyStore.md | 2 -- docs/reference/classes/Store.md | 2 -- docs/reference/functions/batch.md | 2 -- docs/reference/functions/createAsyncAtom.md | 2 -- docs/reference/functions/createAtom.md | 2 -- docs/reference/functions/createStore.md | 2 -- docs/reference/functions/flush.md | 2 -- docs/reference/functions/shallow.md | 2 -- docs/reference/functions/toObserver.md | 2 -- docs/reference/index.md | 2 -- docs/reference/interfaces/Atom.md | 2 -- docs/reference/interfaces/AtomOptions.md | 2 -- docs/reference/interfaces/BaseAtom.md | 2 -- docs/reference/interfaces/InternalBaseAtom.md | 2 -- docs/reference/interfaces/InternalReadonlyAtom.md | 2 -- docs/reference/interfaces/InteropSubscribable.md | 2 -- docs/reference/interfaces/Readable.md | 2 -- docs/reference/interfaces/ReadonlyAtom.md | 2 -- docs/reference/interfaces/Subscribable.md | 2 -- docs/reference/interfaces/Subscription.md | 2 -- docs/reference/type-aliases/AnyAtom.md | 2 -- docs/reference/type-aliases/Observer.md | 2 -- docs/reference/type-aliases/Selection.md | 2 -- docs/reference/type-aliases/StoreAction.md | 2 -- docs/reference/type-aliases/StoreActionMap.md | 2 -- docs/reference/type-aliases/StoreActionsFactory.md | 2 -- 79 files changed, 158 deletions(-) diff --git a/docs/framework/angular/reference/functions/createStoreContext.md b/docs/framework/angular/reference/functions/createStoreContext.md index 9d1a39a8..f79044fc 100644 --- a/docs/framework/angular/reference/functions/createStoreContext.md +++ b/docs/framework/angular/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/angular/reference/functions/injectAtom.md b/docs/framework/angular/reference/functions/injectAtom.md index 8d9bd6ef..e993c076 100644 --- a/docs/framework/angular/reference/functions/injectAtom.md +++ b/docs/framework/angular/reference/functions/injectAtom.md @@ -3,8 +3,6 @@ id: injectAtom title: injectAtom --- -# Function: injectAtom() - ```ts function injectAtom(atom, options?): WritableAtomSignal; ``` diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index a92e9bc2..baca3a87 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -3,8 +3,6 @@ id: injectSelector title: injectSelector --- -# Function: injectSelector() - ```ts function injectSelector( source, diff --git a/docs/framework/angular/reference/functions/injectStore-1.md b/docs/framework/angular/reference/functions/injectStore-1.md index 6e89cddc..8e693eb9 100644 --- a/docs/framework/angular/reference/functions/injectStore-1.md +++ b/docs/framework/angular/reference/functions/injectStore-1.md @@ -3,8 +3,6 @@ id: injectStore title: injectStore --- -# ~~Function: injectStore()~~ - ```ts function injectStore( store, diff --git a/docs/framework/angular/reference/functions/injectStore.md b/docs/framework/angular/reference/functions/injectStore.md index b88a398b..91347fb9 100644 --- a/docs/framework/angular/reference/functions/injectStore.md +++ b/docs/framework/angular/reference/functions/injectStore.md @@ -3,8 +3,6 @@ id: _injectStore title: _injectStore --- -# Function: \_injectStore() - ```ts function _injectStore( store, diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 294379cc..7b5d6475 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/angular-store" title: "@tanstack/angular-store" --- -# @tanstack/angular-store - ## Interfaces - [InjectSelectorOptions](interfaces/InjectSelectorOptions.md) diff --git a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md index 993b6db4..b20bb642 100644 --- a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md @@ -3,8 +3,6 @@ id: InjectSelectorOptions title: InjectSelectorOptions --- -# Interface: InjectSelectorOptions\ - Defined in: [packages/angular-store/src/injectSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectSelector.ts#L11) ## Extends diff --git a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md index ce3ea69a..b197a673 100644 --- a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md +++ b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md @@ -3,8 +3,6 @@ id: WritableAtomSignal title: WritableAtomSignal --- -# Interface: WritableAtomSignal()\ - Defined in: [packages/angular-store/src/injectAtom.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectAtom.ts#L21) A callable signal that reads the current atom value when invoked and diff --git a/docs/framework/angular/reference/type-aliases/SelectionSource.md b/docs/framework/angular/reference/type-aliases/SelectionSource.md index 03444a60..3079d7cb 100644 --- a/docs/framework/angular/reference/type-aliases/SelectionSource.md +++ b/docs/framework/angular/reference/type-aliases/SelectionSource.md @@ -3,8 +3,6 @@ id: SelectionSource title: SelectionSource --- -# Type Alias: SelectionSource\ - ```ts type SelectionSource = object; ``` diff --git a/docs/framework/octane/reference/functions/createStoreContext.md b/docs/framework/octane/reference/functions/createStoreContext.md index b9b0e95f..fd81065b 100644 --- a/docs/framework/octane/reference/functions/createStoreContext.md +++ b/docs/framework/octane/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/octane/reference/functions/useAtom.md b/docs/framework/octane/reference/functions/useAtom.md index 289b16e2..a2813ae0 100644 --- a/docs/framework/octane/reference/functions/useAtom.md +++ b/docs/framework/octane/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom( atom, diff --git a/docs/framework/octane/reference/functions/useCreateAtom.md b/docs/framework/octane/reference/functions/useCreateAtom.md index bdc41bad..ba1f7050 100644 --- a/docs/framework/octane/reference/functions/useCreateAtom.md +++ b/docs/framework/octane/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Readonly atom ```ts diff --git a/docs/framework/octane/reference/functions/useCreateStore.md b/docs/framework/octane/reference/functions/useCreateStore.md index 63b25fe9..a83bb350 100644 --- a/docs/framework/octane/reference/functions/useCreateStore.md +++ b/docs/framework/octane/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Readonly store ```ts diff --git a/docs/framework/octane/reference/functions/useSelector.md b/docs/framework/octane/reference/functions/useSelector.md index a6093657..610792ff 100644 --- a/docs/framework/octane/reference/functions/useSelector.md +++ b/docs/framework/octane/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/octane/reference/index.md b/docs/framework/octane/reference/index.md index 7dbc161c..85438412 100644 --- a/docs/framework/octane/reference/index.md +++ b/docs/framework/octane/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/octane-store" title: "@tanstack/octane-store" --- -# @tanstack/octane-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md index 7f3d33a5..744df62b 100644 --- a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [octane-store/src/useSelector.ts:5](https://github.com/TanStack/store/blob/main/packages/octane-store/src/useSelector.ts#L5) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md index bfc21a03..c7312462 100644 --- a/docs/framework/preact/reference/functions/createStoreContext.md +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md index 9a0daab4..ca7b82ff 100644 --- a/docs/framework/preact/reference/functions/useAtom.md +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md index a92253d0..5eae73c6 100644 --- a/docs/framework/preact/reference/functions/useCreateAtom.md +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md index 56b8f91c..3345e513 100644 --- a/docs/framework/preact/reference/functions/useCreateStore.md +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md index fe1036b3..9ecae133 100644 --- a/docs/framework/preact/reference/functions/useSelector.md +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/preact/reference/functions/useStore-1.md b/docs/framework/preact/reference/functions/useStore-1.md index 9b45156b..1e0e5fa1 100644 --- a/docs/framework/preact/reference/functions/useStore-1.md +++ b/docs/framework/preact/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md index ecfcbe95..da7e2808 100644 --- a/docs/framework/preact/reference/functions/useStore.md +++ b/docs/framework/preact/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index 76afd2bf..fc75d0df 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/preact-store" title: "@tanstack/preact-store" --- -# @tanstack/preact-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md index b3a6fa5e..432ad10c 100644 --- a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createStoreContext.md b/docs/framework/react/reference/functions/createStoreContext.md index c7bfe786..9c81832c 100644 --- a/docs/framework/react/reference/functions/createStoreContext.md +++ b/docs/framework/react/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/react/reference/functions/useAtom.md b/docs/framework/react/reference/functions/useAtom.md index 5cd2eb68..bee705db 100644 --- a/docs/framework/react/reference/functions/useAtom.md +++ b/docs/framework/react/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/react/reference/functions/useCreateAtom.md b/docs/framework/react/reference/functions/useCreateAtom.md index 1b6cfaab..eb5db9fa 100644 --- a/docs/framework/react/reference/functions/useCreateAtom.md +++ b/docs/framework/react/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useCreateStore.md b/docs/framework/react/reference/functions/useCreateStore.md index f01d05ba..07acc257 100644 --- a/docs/framework/react/reference/functions/useCreateStore.md +++ b/docs/framework/react/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useSelector.md b/docs/framework/react/reference/functions/useSelector.md index 4eb73ea7..e4035fbd 100644 --- a/docs/framework/react/reference/functions/useSelector.md +++ b/docs/framework/react/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/react/reference/functions/useStore-1.md b/docs/framework/react/reference/functions/useStore-1.md index 76506468..cfc238f7 100644 --- a/docs/framework/react/reference/functions/useStore-1.md +++ b/docs/framework/react/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/react/reference/functions/useStore.md b/docs/framework/react/reference/functions/useStore.md index bbc43c6b..3ca150f3 100644 --- a/docs/framework/react/reference/functions/useStore.md +++ b/docs/framework/react/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 957bf4c4..4900ddfe 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/react-store" title: "@tanstack/react-store" --- -# @tanstack/react-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/react/reference/interfaces/UseSelectorOptions.md b/docs/framework/react/reference/interfaces/UseSelectorOptions.md index efaa91df..551e84f7 100644 --- a/docs/framework/react/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/react/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [packages/react-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/react-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createStoreContext.md b/docs/framework/solid/reference/functions/createStoreContext.md index 2ff36e6d..41ddddfe 100644 --- a/docs/framework/solid/reference/functions/createStoreContext.md +++ b/docs/framework/solid/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/solid/reference/functions/useAtom.md b/docs/framework/solid/reference/functions/useAtom.md index a05c4337..e40a43e9 100644 --- a/docs/framework/solid/reference/functions/useAtom.md +++ b/docs/framework/solid/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Accessor, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/solid/reference/functions/useSelector.md b/docs/framework/solid/reference/functions/useSelector.md index ed6f3961..4a674915 100644 --- a/docs/framework/solid/reference/functions/useSelector.md +++ b/docs/framework/solid/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/solid/reference/functions/useStore-1.md b/docs/framework/solid/reference/functions/useStore-1.md index e51f0ccb..4f3abc94 100644 --- a/docs/framework/solid/reference/functions/useStore-1.md +++ b/docs/framework/solid/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/solid/reference/functions/useStore.md b/docs/framework/solid/reference/functions/useStore.md index 046e7a04..b1ffe800 100644 --- a/docs/framework/solid/reference/functions/useStore.md +++ b/docs/framework/solid/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index bfe6ce88..45eda670 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/solid-store" title: "@tanstack/solid-store" --- -# @tanstack/solid-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md index 2d3845b8..82da6866 100644 --- a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [solid-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/solid-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/useAtom.md b/docs/framework/svelte/reference/functions/useAtom.md index 727d42bb..6e16b4d2 100644 --- a/docs/framework/svelte/reference/functions/useAtom.md +++ b/docs/framework/svelte/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [{ current: TValue; diff --git a/docs/framework/svelte/reference/functions/useSelector.md b/docs/framework/svelte/reference/functions/useSelector.md index a0abbb21..6e65346e 100644 --- a/docs/framework/svelte/reference/functions/useSelector.md +++ b/docs/framework/svelte/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/svelte/reference/functions/useStore-1.md b/docs/framework/svelte/reference/functions/useStore-1.md index b3d49758..50133785 100644 --- a/docs/framework/svelte/reference/functions/useStore-1.md +++ b/docs/framework/svelte/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/svelte/reference/functions/useStore.md b/docs/framework/svelte/reference/functions/useStore.md index 8de580f1..5499b29c 100644 --- a/docs/framework/svelte/reference/functions/useStore.md +++ b/docs/framework/svelte/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 531a5c99..39f4071a 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/svelte-store" title: "@tanstack/svelte-store" --- -# @tanstack/svelte-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md index 6dfeceff..a1287ba6 100644 --- a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [svelte-store/src/useSelector.svelte.ts:3](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/useSelector.svelte.ts#L3) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md index 6b598d89..1ba41a97 100644 --- a/docs/framework/vue/reference/functions/useAtom.md +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md index adc70581..eb1fc8e2 100644 --- a/docs/framework/vue/reference/functions/useSelector.md +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/vue/reference/functions/useStore-1.md b/docs/framework/vue/reference/functions/useStore-1.md index a96bb61e..f7f6be01 100644 --- a/docs/framework/vue/reference/functions/useStore-1.md +++ b/docs/framework/vue/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md index 0a14ea38..98f104ac 100644 --- a/docs/framework/vue/reference/functions/useStore.md +++ b/docs/framework/vue/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index cc4e9333..6f5d5f42 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/vue-store" title: "@tanstack/vue-store" --- -# @tanstack/vue-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md index dc0616ce..2838e456 100644 --- a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [vue-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/vue-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/reference/classes/ReadonlyStore.md b/docs/reference/classes/ReadonlyStore.md index e23ee15c..97dd2e88 100644 --- a/docs/reference/classes/ReadonlyStore.md +++ b/docs/reference/classes/ReadonlyStore.md @@ -3,8 +3,6 @@ id: ReadonlyStore title: ReadonlyStore --- -# Class: ReadonlyStore\ - Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59) ## Type Parameters diff --git a/docs/reference/classes/Store.md b/docs/reference/classes/Store.md index 346926a3..7d0eab2c 100644 --- a/docs/reference/classes/Store.md +++ b/docs/reference/classes/Store.md @@ -3,8 +3,6 @@ id: Store title: Store --- -# Class: Store\ - Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15) ## Type Parameters diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index f3de25ce..43c3f38e 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -3,8 +3,6 @@ id: batch title: batch --- -# Function: batch() - ```ts function batch(fn): void; ``` diff --git a/docs/reference/functions/createAsyncAtom.md b/docs/reference/functions/createAsyncAtom.md index 828bfce8..4bf0c602 100644 --- a/docs/reference/functions/createAsyncAtom.md +++ b/docs/reference/functions/createAsyncAtom.md @@ -3,8 +3,6 @@ id: createAsyncAtom title: createAsyncAtom --- -# Function: createAsyncAtom() - ```ts function createAsyncAtom(getValue, options?): ReadonlyAtom>; ``` diff --git a/docs/reference/functions/createAtom.md b/docs/reference/functions/createAtom.md index 79dce560..eed96287 100644 --- a/docs/reference/functions/createAtom.md +++ b/docs/reference/functions/createAtom.md @@ -3,8 +3,6 @@ id: createAtom title: createAtom --- -# Function: createAtom() - ## Call Signature ```ts diff --git a/docs/reference/functions/createStore.md b/docs/reference/functions/createStore.md index 8c211275..827f47e2 100644 --- a/docs/reference/functions/createStore.md +++ b/docs/reference/functions/createStore.md @@ -3,8 +3,6 @@ id: createStore title: createStore --- -# Function: createStore() - ## Call Signature ```ts diff --git a/docs/reference/functions/flush.md b/docs/reference/functions/flush.md index 37ab69a8..4e1ef6c9 100644 --- a/docs/reference/functions/flush.md +++ b/docs/reference/functions/flush.md @@ -3,8 +3,6 @@ id: flush title: flush --- -# Function: flush() - ```ts function flush(): void; ``` diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md index fb3b313a..e371f8c1 100644 --- a/docs/reference/functions/shallow.md +++ b/docs/reference/functions/shallow.md @@ -3,8 +3,6 @@ id: shallow title: shallow --- -# Function: shallow() - ```ts function shallow(objA, objB): boolean; ``` diff --git a/docs/reference/functions/toObserver.md b/docs/reference/functions/toObserver.md index 67cf733b..b303332c 100644 --- a/docs/reference/functions/toObserver.md +++ b/docs/reference/functions/toObserver.md @@ -3,8 +3,6 @@ id: toObserver title: toObserver --- -# Function: toObserver() - ```ts function toObserver( nextHandler?, diff --git a/docs/reference/index.md b/docs/reference/index.md index afc8e5dd..9ef00a64 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/store" title: "@tanstack/store" --- -# @tanstack/store - ## Classes - [ReadonlyStore](classes/ReadonlyStore.md) diff --git a/docs/reference/interfaces/Atom.md b/docs/reference/interfaces/Atom.md index 63124fd2..279539e7 100644 --- a/docs/reference/interfaces/Atom.md +++ b/docs/reference/interfaces/Atom.md @@ -3,8 +3,6 @@ id: Atom title: Atom --- -# Interface: Atom\ - Defined in: [types.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L42) ## Extends diff --git a/docs/reference/interfaces/AtomOptions.md b/docs/reference/interfaces/AtomOptions.md index c05fee8d..1d7e29cd 100644 --- a/docs/reference/interfaces/AtomOptions.md +++ b/docs/reference/interfaces/AtomOptions.md @@ -3,8 +3,6 @@ id: AtomOptions title: AtomOptions --- -# Interface: AtomOptions\ - Defined in: [types.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L47) ## Type Parameters diff --git a/docs/reference/interfaces/BaseAtom.md b/docs/reference/interfaces/BaseAtom.md index 57de2ed9..8a2a0c47 100644 --- a/docs/reference/interfaces/BaseAtom.md +++ b/docs/reference/interfaces/BaseAtom.md @@ -3,8 +3,6 @@ id: BaseAtom title: BaseAtom --- -# Interface: BaseAtom\ - Defined in: [types.ts:33](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L33) ## Extends diff --git a/docs/reference/interfaces/InternalBaseAtom.md b/docs/reference/interfaces/InternalBaseAtom.md index b2716e81..33fd0bd7 100644 --- a/docs/reference/interfaces/InternalBaseAtom.md +++ b/docs/reference/interfaces/InternalBaseAtom.md @@ -3,8 +3,6 @@ id: InternalBaseAtom title: InternalBaseAtom --- -# Interface: InternalBaseAtom\ - Defined in: [types.ts:35](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L35) ## Extends diff --git a/docs/reference/interfaces/InternalReadonlyAtom.md b/docs/reference/interfaces/InternalReadonlyAtom.md index defd840e..44632117 100644 --- a/docs/reference/interfaces/InternalReadonlyAtom.md +++ b/docs/reference/interfaces/InternalReadonlyAtom.md @@ -3,8 +3,6 @@ id: InternalReadonlyAtom title: InternalReadonlyAtom --- -# Interface: InternalReadonlyAtom\ - Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53) ## Extends diff --git a/docs/reference/interfaces/InteropSubscribable.md b/docs/reference/interfaces/InteropSubscribable.md index 45c4cea3..f3dad5e5 100644 --- a/docs/reference/interfaces/InteropSubscribable.md +++ b/docs/reference/interfaces/InteropSubscribable.md @@ -3,8 +3,6 @@ id: InteropSubscribable title: InteropSubscribable --- -# Interface: InteropSubscribable\ - Defined in: [types.ts:5](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L5) ## Extended by diff --git a/docs/reference/interfaces/Readable.md b/docs/reference/interfaces/Readable.md index 96f344b1..e9e84490 100644 --- a/docs/reference/interfaces/Readable.md +++ b/docs/reference/interfaces/Readable.md @@ -3,8 +3,6 @@ id: Readable title: Readable --- -# Interface: Readable\ - Defined in: [types.ts:29](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L29) ## Extends diff --git a/docs/reference/interfaces/ReadonlyAtom.md b/docs/reference/interfaces/ReadonlyAtom.md index 2aeaa860..bc98e2de 100644 --- a/docs/reference/interfaces/ReadonlyAtom.md +++ b/docs/reference/interfaces/ReadonlyAtom.md @@ -3,8 +3,6 @@ id: ReadonlyAtom title: ReadonlyAtom --- -# Interface: ReadonlyAtom\ - Defined in: [types.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L67) An atom that is read-only and cannot be set. diff --git a/docs/reference/interfaces/Subscribable.md b/docs/reference/interfaces/Subscribable.md index 0857be0c..c15ec4b5 100644 --- a/docs/reference/interfaces/Subscribable.md +++ b/docs/reference/interfaces/Subscribable.md @@ -3,8 +3,6 @@ id: Subscribable title: Subscribable --- -# Interface: Subscribable\ - Defined in: [types.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L20) ## Extends diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index 5ddc5fba..d258cd39 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -3,8 +3,6 @@ id: Subscription title: Subscription --- -# Interface: Subscription - Defined in: [types.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L16) ## Properties diff --git a/docs/reference/type-aliases/AnyAtom.md b/docs/reference/type-aliases/AnyAtom.md index d41e125c..eb2c7dbd 100644 --- a/docs/reference/type-aliases/AnyAtom.md +++ b/docs/reference/type-aliases/AnyAtom.md @@ -3,8 +3,6 @@ id: AnyAtom title: AnyAtom --- -# Type Alias: AnyAtom - ```ts type AnyAtom = BaseAtom; ``` diff --git a/docs/reference/type-aliases/Observer.md b/docs/reference/type-aliases/Observer.md index 47cd75dd..65f901b7 100644 --- a/docs/reference/type-aliases/Observer.md +++ b/docs/reference/type-aliases/Observer.md @@ -3,8 +3,6 @@ id: Observer title: Observer --- -# Type Alias: Observer\ - ```ts type Observer = object; ``` diff --git a/docs/reference/type-aliases/Selection.md b/docs/reference/type-aliases/Selection.md index 484ad187..91b27b2a 100644 --- a/docs/reference/type-aliases/Selection.md +++ b/docs/reference/type-aliases/Selection.md @@ -3,8 +3,6 @@ id: Selection title: Selection --- -# Type Alias: Selection\ - ```ts type Selection = Readable; ``` diff --git a/docs/reference/type-aliases/StoreAction.md b/docs/reference/type-aliases/StoreAction.md index 1e839025..645ac1cd 100644 --- a/docs/reference/type-aliases/StoreAction.md +++ b/docs/reference/type-aliases/StoreAction.md @@ -3,8 +3,6 @@ id: StoreAction title: StoreAction --- -# Type Alias: StoreAction() - ```ts type StoreAction = (...args) => any; ``` diff --git a/docs/reference/type-aliases/StoreActionMap.md b/docs/reference/type-aliases/StoreActionMap.md index 5191c5f5..fd5df617 100644 --- a/docs/reference/type-aliases/StoreActionMap.md +++ b/docs/reference/type-aliases/StoreActionMap.md @@ -3,8 +3,6 @@ id: StoreActionMap title: StoreActionMap --- -# Type Alias: StoreActionMap - ```ts type StoreActionMap = Record; ``` diff --git a/docs/reference/type-aliases/StoreActionsFactory.md b/docs/reference/type-aliases/StoreActionsFactory.md index b7caaee8..b22ccb91 100644 --- a/docs/reference/type-aliases/StoreActionsFactory.md +++ b/docs/reference/type-aliases/StoreActionsFactory.md @@ -3,8 +3,6 @@ id: StoreActionsFactory title: StoreActionsFactory --- -# Type Alias: StoreActionsFactory()\ - ```ts type StoreActionsFactory = (store) => TActions; ``` From 19480d485325de19503b2cafff87cd2000beebe7 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 10:51:24 +0000 Subject: [PATCH 2/5] ci: apply automated fixes and generate docs --- .../framework/angular/reference/functions/createStoreContext.md | 2 ++ docs/framework/angular/reference/functions/injectAtom.md | 2 ++ docs/framework/angular/reference/functions/injectSelector.md | 2 ++ docs/framework/angular/reference/functions/injectStore-1.md | 2 ++ docs/framework/angular/reference/functions/injectStore.md | 2 ++ docs/framework/angular/reference/index.md | 2 ++ .../angular/reference/interfaces/InjectSelectorOptions.md | 2 ++ .../angular/reference/interfaces/WritableAtomSignal.md | 2 ++ .../framework/angular/reference/type-aliases/SelectionSource.md | 2 ++ docs/framework/octane/reference/functions/createStoreContext.md | 2 ++ docs/framework/octane/reference/functions/useAtom.md | 2 ++ docs/framework/octane/reference/functions/useCreateAtom.md | 2 ++ docs/framework/octane/reference/functions/useCreateStore.md | 2 ++ docs/framework/octane/reference/functions/useSelector.md | 2 ++ docs/framework/octane/reference/index.md | 2 ++ .../framework/octane/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/preact/reference/functions/createStoreContext.md | 2 ++ docs/framework/preact/reference/functions/useAtom.md | 2 ++ docs/framework/preact/reference/functions/useCreateAtom.md | 2 ++ docs/framework/preact/reference/functions/useCreateStore.md | 2 ++ docs/framework/preact/reference/functions/useSelector.md | 2 ++ docs/framework/preact/reference/functions/useStore-1.md | 2 ++ docs/framework/preact/reference/functions/useStore.md | 2 ++ docs/framework/preact/reference/index.md | 2 ++ .../framework/preact/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/react/reference/functions/createStoreContext.md | 2 ++ docs/framework/react/reference/functions/useAtom.md | 2 ++ docs/framework/react/reference/functions/useCreateAtom.md | 2 ++ docs/framework/react/reference/functions/useCreateStore.md | 2 ++ docs/framework/react/reference/functions/useSelector.md | 2 ++ docs/framework/react/reference/functions/useStore-1.md | 2 ++ docs/framework/react/reference/functions/useStore.md | 2 ++ docs/framework/react/reference/index.md | 2 ++ docs/framework/react/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/solid/reference/functions/createStoreContext.md | 2 ++ docs/framework/solid/reference/functions/useAtom.md | 2 ++ docs/framework/solid/reference/functions/useSelector.md | 2 ++ docs/framework/solid/reference/functions/useStore-1.md | 2 ++ docs/framework/solid/reference/functions/useStore.md | 2 ++ docs/framework/solid/reference/index.md | 2 ++ docs/framework/solid/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/svelte/reference/functions/useAtom.md | 2 ++ docs/framework/svelte/reference/functions/useSelector.md | 2 ++ docs/framework/svelte/reference/functions/useStore-1.md | 2 ++ docs/framework/svelte/reference/functions/useStore.md | 2 ++ docs/framework/svelte/reference/index.md | 2 ++ .../framework/svelte/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/vue/reference/functions/useAtom.md | 2 ++ docs/framework/vue/reference/functions/useSelector.md | 2 ++ docs/framework/vue/reference/functions/useStore-1.md | 2 ++ docs/framework/vue/reference/functions/useStore.md | 2 ++ docs/framework/vue/reference/index.md | 2 ++ docs/framework/vue/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/reference/classes/ReadonlyStore.md | 2 ++ docs/reference/classes/Store.md | 2 ++ docs/reference/functions/batch.md | 2 ++ docs/reference/functions/createAsyncAtom.md | 2 ++ docs/reference/functions/createAtom.md | 2 ++ docs/reference/functions/createStore.md | 2 ++ docs/reference/functions/flush.md | 2 ++ docs/reference/functions/shallow.md | 2 ++ docs/reference/functions/toObserver.md | 2 ++ docs/reference/index.md | 2 ++ docs/reference/interfaces/Atom.md | 2 ++ docs/reference/interfaces/AtomOptions.md | 2 ++ docs/reference/interfaces/BaseAtom.md | 2 ++ docs/reference/interfaces/InternalBaseAtom.md | 2 ++ docs/reference/interfaces/InternalReadonlyAtom.md | 2 ++ docs/reference/interfaces/InteropSubscribable.md | 2 ++ docs/reference/interfaces/Readable.md | 2 ++ docs/reference/interfaces/ReadonlyAtom.md | 2 ++ docs/reference/interfaces/Subscribable.md | 2 ++ docs/reference/interfaces/Subscription.md | 2 ++ docs/reference/type-aliases/AnyAtom.md | 2 ++ docs/reference/type-aliases/Observer.md | 2 ++ docs/reference/type-aliases/Selection.md | 2 ++ docs/reference/type-aliases/StoreAction.md | 2 ++ docs/reference/type-aliases/StoreActionMap.md | 2 ++ docs/reference/type-aliases/StoreActionsFactory.md | 2 ++ 79 files changed, 158 insertions(+) diff --git a/docs/framework/angular/reference/functions/createStoreContext.md b/docs/framework/angular/reference/functions/createStoreContext.md index f79044fc..9d1a39a8 100644 --- a/docs/framework/angular/reference/functions/createStoreContext.md +++ b/docs/framework/angular/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/angular/reference/functions/injectAtom.md b/docs/framework/angular/reference/functions/injectAtom.md index e993c076..8d9bd6ef 100644 --- a/docs/framework/angular/reference/functions/injectAtom.md +++ b/docs/framework/angular/reference/functions/injectAtom.md @@ -3,6 +3,8 @@ id: injectAtom title: injectAtom --- +# Function: injectAtom() + ```ts function injectAtom(atom, options?): WritableAtomSignal; ``` diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index baca3a87..a92e9bc2 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -3,6 +3,8 @@ id: injectSelector title: injectSelector --- +# Function: injectSelector() + ```ts function injectSelector( source, diff --git a/docs/framework/angular/reference/functions/injectStore-1.md b/docs/framework/angular/reference/functions/injectStore-1.md index 8e693eb9..6e89cddc 100644 --- a/docs/framework/angular/reference/functions/injectStore-1.md +++ b/docs/framework/angular/reference/functions/injectStore-1.md @@ -3,6 +3,8 @@ id: injectStore title: injectStore --- +# ~~Function: injectStore()~~ + ```ts function injectStore( store, diff --git a/docs/framework/angular/reference/functions/injectStore.md b/docs/framework/angular/reference/functions/injectStore.md index 91347fb9..b88a398b 100644 --- a/docs/framework/angular/reference/functions/injectStore.md +++ b/docs/framework/angular/reference/functions/injectStore.md @@ -3,6 +3,8 @@ id: _injectStore title: _injectStore --- +# Function: \_injectStore() + ```ts function _injectStore( store, diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 7b5d6475..294379cc 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/angular-store" title: "@tanstack/angular-store" --- +# @tanstack/angular-store + ## Interfaces - [InjectSelectorOptions](interfaces/InjectSelectorOptions.md) diff --git a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md index b20bb642..993b6db4 100644 --- a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md @@ -3,6 +3,8 @@ id: InjectSelectorOptions title: InjectSelectorOptions --- +# Interface: InjectSelectorOptions\ + Defined in: [packages/angular-store/src/injectSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectSelector.ts#L11) ## Extends diff --git a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md index b197a673..ce3ea69a 100644 --- a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md +++ b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md @@ -3,6 +3,8 @@ id: WritableAtomSignal title: WritableAtomSignal --- +# Interface: WritableAtomSignal()\ + Defined in: [packages/angular-store/src/injectAtom.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectAtom.ts#L21) A callable signal that reads the current atom value when invoked and diff --git a/docs/framework/angular/reference/type-aliases/SelectionSource.md b/docs/framework/angular/reference/type-aliases/SelectionSource.md index 3079d7cb..03444a60 100644 --- a/docs/framework/angular/reference/type-aliases/SelectionSource.md +++ b/docs/framework/angular/reference/type-aliases/SelectionSource.md @@ -3,6 +3,8 @@ id: SelectionSource title: SelectionSource --- +# Type Alias: SelectionSource\ + ```ts type SelectionSource = object; ``` diff --git a/docs/framework/octane/reference/functions/createStoreContext.md b/docs/framework/octane/reference/functions/createStoreContext.md index fd81065b..b9b0e95f 100644 --- a/docs/framework/octane/reference/functions/createStoreContext.md +++ b/docs/framework/octane/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/octane/reference/functions/useAtom.md b/docs/framework/octane/reference/functions/useAtom.md index a2813ae0..289b16e2 100644 --- a/docs/framework/octane/reference/functions/useAtom.md +++ b/docs/framework/octane/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom( atom, diff --git a/docs/framework/octane/reference/functions/useCreateAtom.md b/docs/framework/octane/reference/functions/useCreateAtom.md index ba1f7050..bdc41bad 100644 --- a/docs/framework/octane/reference/functions/useCreateAtom.md +++ b/docs/framework/octane/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Readonly atom ```ts diff --git a/docs/framework/octane/reference/functions/useCreateStore.md b/docs/framework/octane/reference/functions/useCreateStore.md index a83bb350..63b25fe9 100644 --- a/docs/framework/octane/reference/functions/useCreateStore.md +++ b/docs/framework/octane/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Readonly store ```ts diff --git a/docs/framework/octane/reference/functions/useSelector.md b/docs/framework/octane/reference/functions/useSelector.md index 610792ff..a6093657 100644 --- a/docs/framework/octane/reference/functions/useSelector.md +++ b/docs/framework/octane/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/octane/reference/index.md b/docs/framework/octane/reference/index.md index 85438412..7dbc161c 100644 --- a/docs/framework/octane/reference/index.md +++ b/docs/framework/octane/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/octane-store" title: "@tanstack/octane-store" --- +# @tanstack/octane-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md index 744df62b..7f3d33a5 100644 --- a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [octane-store/src/useSelector.ts:5](https://github.com/TanStack/store/blob/main/packages/octane-store/src/useSelector.ts#L5) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md index c7312462..bfc21a03 100644 --- a/docs/framework/preact/reference/functions/createStoreContext.md +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md index ca7b82ff..9a0daab4 100644 --- a/docs/framework/preact/reference/functions/useAtom.md +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md index 5eae73c6..a92253d0 100644 --- a/docs/framework/preact/reference/functions/useCreateAtom.md +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md index 3345e513..56b8f91c 100644 --- a/docs/framework/preact/reference/functions/useCreateStore.md +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md index 9ecae133..fe1036b3 100644 --- a/docs/framework/preact/reference/functions/useSelector.md +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/preact/reference/functions/useStore-1.md b/docs/framework/preact/reference/functions/useStore-1.md index 1e0e5fa1..9b45156b 100644 --- a/docs/framework/preact/reference/functions/useStore-1.md +++ b/docs/framework/preact/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md index da7e2808..ecfcbe95 100644 --- a/docs/framework/preact/reference/functions/useStore.md +++ b/docs/framework/preact/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index fc75d0df..76afd2bf 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/preact-store" title: "@tanstack/preact-store" --- +# @tanstack/preact-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md index 432ad10c..b3a6fa5e 100644 --- a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createStoreContext.md b/docs/framework/react/reference/functions/createStoreContext.md index 9c81832c..c7bfe786 100644 --- a/docs/framework/react/reference/functions/createStoreContext.md +++ b/docs/framework/react/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/react/reference/functions/useAtom.md b/docs/framework/react/reference/functions/useAtom.md index bee705db..5cd2eb68 100644 --- a/docs/framework/react/reference/functions/useAtom.md +++ b/docs/framework/react/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/react/reference/functions/useCreateAtom.md b/docs/framework/react/reference/functions/useCreateAtom.md index eb5db9fa..1b6cfaab 100644 --- a/docs/framework/react/reference/functions/useCreateAtom.md +++ b/docs/framework/react/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useCreateStore.md b/docs/framework/react/reference/functions/useCreateStore.md index 07acc257..f01d05ba 100644 --- a/docs/framework/react/reference/functions/useCreateStore.md +++ b/docs/framework/react/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useSelector.md b/docs/framework/react/reference/functions/useSelector.md index e4035fbd..4eb73ea7 100644 --- a/docs/framework/react/reference/functions/useSelector.md +++ b/docs/framework/react/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/react/reference/functions/useStore-1.md b/docs/framework/react/reference/functions/useStore-1.md index cfc238f7..76506468 100644 --- a/docs/framework/react/reference/functions/useStore-1.md +++ b/docs/framework/react/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/react/reference/functions/useStore.md b/docs/framework/react/reference/functions/useStore.md index 3ca150f3..bbc43c6b 100644 --- a/docs/framework/react/reference/functions/useStore.md +++ b/docs/framework/react/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 4900ddfe..957bf4c4 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/react-store" title: "@tanstack/react-store" --- +# @tanstack/react-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/react/reference/interfaces/UseSelectorOptions.md b/docs/framework/react/reference/interfaces/UseSelectorOptions.md index 551e84f7..efaa91df 100644 --- a/docs/framework/react/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/react/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [packages/react-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/react-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createStoreContext.md b/docs/framework/solid/reference/functions/createStoreContext.md index 41ddddfe..2ff36e6d 100644 --- a/docs/framework/solid/reference/functions/createStoreContext.md +++ b/docs/framework/solid/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/solid/reference/functions/useAtom.md b/docs/framework/solid/reference/functions/useAtom.md index e40a43e9..a05c4337 100644 --- a/docs/framework/solid/reference/functions/useAtom.md +++ b/docs/framework/solid/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [Accessor, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/solid/reference/functions/useSelector.md b/docs/framework/solid/reference/functions/useSelector.md index 4a674915..ed6f3961 100644 --- a/docs/framework/solid/reference/functions/useSelector.md +++ b/docs/framework/solid/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/solid/reference/functions/useStore-1.md b/docs/framework/solid/reference/functions/useStore-1.md index 4f3abc94..e51f0ccb 100644 --- a/docs/framework/solid/reference/functions/useStore-1.md +++ b/docs/framework/solid/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/solid/reference/functions/useStore.md b/docs/framework/solid/reference/functions/useStore.md index b1ffe800..046e7a04 100644 --- a/docs/framework/solid/reference/functions/useStore.md +++ b/docs/framework/solid/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 45eda670..bfe6ce88 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/solid-store" title: "@tanstack/solid-store" --- +# @tanstack/solid-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md index 82da6866..2d3845b8 100644 --- a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [solid-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/solid-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/useAtom.md b/docs/framework/svelte/reference/functions/useAtom.md index 6e16b4d2..727d42bb 100644 --- a/docs/framework/svelte/reference/functions/useAtom.md +++ b/docs/framework/svelte/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [{ current: TValue; diff --git a/docs/framework/svelte/reference/functions/useSelector.md b/docs/framework/svelte/reference/functions/useSelector.md index 6e65346e..a0abbb21 100644 --- a/docs/framework/svelte/reference/functions/useSelector.md +++ b/docs/framework/svelte/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/svelte/reference/functions/useStore-1.md b/docs/framework/svelte/reference/functions/useStore-1.md index 50133785..b3d49758 100644 --- a/docs/framework/svelte/reference/functions/useStore-1.md +++ b/docs/framework/svelte/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/svelte/reference/functions/useStore.md b/docs/framework/svelte/reference/functions/useStore.md index 5499b29c..8de580f1 100644 --- a/docs/framework/svelte/reference/functions/useStore.md +++ b/docs/framework/svelte/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 39f4071a..531a5c99 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/svelte-store" title: "@tanstack/svelte-store" --- +# @tanstack/svelte-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md index a1287ba6..6dfeceff 100644 --- a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [svelte-store/src/useSelector.svelte.ts:3](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/useSelector.svelte.ts#L3) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md index 1ba41a97..6b598d89 100644 --- a/docs/framework/vue/reference/functions/useAtom.md +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md index eb1fc8e2..adc70581 100644 --- a/docs/framework/vue/reference/functions/useSelector.md +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/vue/reference/functions/useStore-1.md b/docs/framework/vue/reference/functions/useStore-1.md index f7f6be01..a96bb61e 100644 --- a/docs/framework/vue/reference/functions/useStore-1.md +++ b/docs/framework/vue/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md index 98f104ac..0a14ea38 100644 --- a/docs/framework/vue/reference/functions/useStore.md +++ b/docs/framework/vue/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 6f5d5f42..cc4e9333 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/vue-store" title: "@tanstack/vue-store" --- +# @tanstack/vue-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md index 2838e456..dc0616ce 100644 --- a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [vue-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/vue-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/reference/classes/ReadonlyStore.md b/docs/reference/classes/ReadonlyStore.md index 97dd2e88..e23ee15c 100644 --- a/docs/reference/classes/ReadonlyStore.md +++ b/docs/reference/classes/ReadonlyStore.md @@ -3,6 +3,8 @@ id: ReadonlyStore title: ReadonlyStore --- +# Class: ReadonlyStore\ + Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59) ## Type Parameters diff --git a/docs/reference/classes/Store.md b/docs/reference/classes/Store.md index 7d0eab2c..346926a3 100644 --- a/docs/reference/classes/Store.md +++ b/docs/reference/classes/Store.md @@ -3,6 +3,8 @@ id: Store title: Store --- +# Class: Store\ + Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15) ## Type Parameters diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index 43c3f38e..f3de25ce 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -3,6 +3,8 @@ id: batch title: batch --- +# Function: batch() + ```ts function batch(fn): void; ``` diff --git a/docs/reference/functions/createAsyncAtom.md b/docs/reference/functions/createAsyncAtom.md index 4bf0c602..828bfce8 100644 --- a/docs/reference/functions/createAsyncAtom.md +++ b/docs/reference/functions/createAsyncAtom.md @@ -3,6 +3,8 @@ id: createAsyncAtom title: createAsyncAtom --- +# Function: createAsyncAtom() + ```ts function createAsyncAtom(getValue, options?): ReadonlyAtom>; ``` diff --git a/docs/reference/functions/createAtom.md b/docs/reference/functions/createAtom.md index eed96287..79dce560 100644 --- a/docs/reference/functions/createAtom.md +++ b/docs/reference/functions/createAtom.md @@ -3,6 +3,8 @@ id: createAtom title: createAtom --- +# Function: createAtom() + ## Call Signature ```ts diff --git a/docs/reference/functions/createStore.md b/docs/reference/functions/createStore.md index 827f47e2..8c211275 100644 --- a/docs/reference/functions/createStore.md +++ b/docs/reference/functions/createStore.md @@ -3,6 +3,8 @@ id: createStore title: createStore --- +# Function: createStore() + ## Call Signature ```ts diff --git a/docs/reference/functions/flush.md b/docs/reference/functions/flush.md index 4e1ef6c9..37ab69a8 100644 --- a/docs/reference/functions/flush.md +++ b/docs/reference/functions/flush.md @@ -3,6 +3,8 @@ id: flush title: flush --- +# Function: flush() + ```ts function flush(): void; ``` diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md index e371f8c1..fb3b313a 100644 --- a/docs/reference/functions/shallow.md +++ b/docs/reference/functions/shallow.md @@ -3,6 +3,8 @@ id: shallow title: shallow --- +# Function: shallow() + ```ts function shallow(objA, objB): boolean; ``` diff --git a/docs/reference/functions/toObserver.md b/docs/reference/functions/toObserver.md index b303332c..67cf733b 100644 --- a/docs/reference/functions/toObserver.md +++ b/docs/reference/functions/toObserver.md @@ -3,6 +3,8 @@ id: toObserver title: toObserver --- +# Function: toObserver() + ```ts function toObserver( nextHandler?, diff --git a/docs/reference/index.md b/docs/reference/index.md index 9ef00a64..afc8e5dd 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/store" title: "@tanstack/store" --- +# @tanstack/store + ## Classes - [ReadonlyStore](classes/ReadonlyStore.md) diff --git a/docs/reference/interfaces/Atom.md b/docs/reference/interfaces/Atom.md index 279539e7..63124fd2 100644 --- a/docs/reference/interfaces/Atom.md +++ b/docs/reference/interfaces/Atom.md @@ -3,6 +3,8 @@ id: Atom title: Atom --- +# Interface: Atom\ + Defined in: [types.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L42) ## Extends diff --git a/docs/reference/interfaces/AtomOptions.md b/docs/reference/interfaces/AtomOptions.md index 1d7e29cd..c05fee8d 100644 --- a/docs/reference/interfaces/AtomOptions.md +++ b/docs/reference/interfaces/AtomOptions.md @@ -3,6 +3,8 @@ id: AtomOptions title: AtomOptions --- +# Interface: AtomOptions\ + Defined in: [types.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L47) ## Type Parameters diff --git a/docs/reference/interfaces/BaseAtom.md b/docs/reference/interfaces/BaseAtom.md index 8a2a0c47..57de2ed9 100644 --- a/docs/reference/interfaces/BaseAtom.md +++ b/docs/reference/interfaces/BaseAtom.md @@ -3,6 +3,8 @@ id: BaseAtom title: BaseAtom --- +# Interface: BaseAtom\ + Defined in: [types.ts:33](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L33) ## Extends diff --git a/docs/reference/interfaces/InternalBaseAtom.md b/docs/reference/interfaces/InternalBaseAtom.md index 33fd0bd7..b2716e81 100644 --- a/docs/reference/interfaces/InternalBaseAtom.md +++ b/docs/reference/interfaces/InternalBaseAtom.md @@ -3,6 +3,8 @@ id: InternalBaseAtom title: InternalBaseAtom --- +# Interface: InternalBaseAtom\ + Defined in: [types.ts:35](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L35) ## Extends diff --git a/docs/reference/interfaces/InternalReadonlyAtom.md b/docs/reference/interfaces/InternalReadonlyAtom.md index 44632117..defd840e 100644 --- a/docs/reference/interfaces/InternalReadonlyAtom.md +++ b/docs/reference/interfaces/InternalReadonlyAtom.md @@ -3,6 +3,8 @@ id: InternalReadonlyAtom title: InternalReadonlyAtom --- +# Interface: InternalReadonlyAtom\ + Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53) ## Extends diff --git a/docs/reference/interfaces/InteropSubscribable.md b/docs/reference/interfaces/InteropSubscribable.md index f3dad5e5..45c4cea3 100644 --- a/docs/reference/interfaces/InteropSubscribable.md +++ b/docs/reference/interfaces/InteropSubscribable.md @@ -3,6 +3,8 @@ id: InteropSubscribable title: InteropSubscribable --- +# Interface: InteropSubscribable\ + Defined in: [types.ts:5](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L5) ## Extended by diff --git a/docs/reference/interfaces/Readable.md b/docs/reference/interfaces/Readable.md index e9e84490..96f344b1 100644 --- a/docs/reference/interfaces/Readable.md +++ b/docs/reference/interfaces/Readable.md @@ -3,6 +3,8 @@ id: Readable title: Readable --- +# Interface: Readable\ + Defined in: [types.ts:29](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L29) ## Extends diff --git a/docs/reference/interfaces/ReadonlyAtom.md b/docs/reference/interfaces/ReadonlyAtom.md index bc98e2de..2aeaa860 100644 --- a/docs/reference/interfaces/ReadonlyAtom.md +++ b/docs/reference/interfaces/ReadonlyAtom.md @@ -3,6 +3,8 @@ id: ReadonlyAtom title: ReadonlyAtom --- +# Interface: ReadonlyAtom\ + Defined in: [types.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L67) An atom that is read-only and cannot be set. diff --git a/docs/reference/interfaces/Subscribable.md b/docs/reference/interfaces/Subscribable.md index c15ec4b5..0857be0c 100644 --- a/docs/reference/interfaces/Subscribable.md +++ b/docs/reference/interfaces/Subscribable.md @@ -3,6 +3,8 @@ id: Subscribable title: Subscribable --- +# Interface: Subscribable\ + Defined in: [types.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L20) ## Extends diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index d258cd39..5ddc5fba 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -3,6 +3,8 @@ id: Subscription title: Subscription --- +# Interface: Subscription + Defined in: [types.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L16) ## Properties diff --git a/docs/reference/type-aliases/AnyAtom.md b/docs/reference/type-aliases/AnyAtom.md index eb2c7dbd..d41e125c 100644 --- a/docs/reference/type-aliases/AnyAtom.md +++ b/docs/reference/type-aliases/AnyAtom.md @@ -3,6 +3,8 @@ id: AnyAtom title: AnyAtom --- +# Type Alias: AnyAtom + ```ts type AnyAtom = BaseAtom; ``` diff --git a/docs/reference/type-aliases/Observer.md b/docs/reference/type-aliases/Observer.md index 65f901b7..47cd75dd 100644 --- a/docs/reference/type-aliases/Observer.md +++ b/docs/reference/type-aliases/Observer.md @@ -3,6 +3,8 @@ id: Observer title: Observer --- +# Type Alias: Observer\ + ```ts type Observer = object; ``` diff --git a/docs/reference/type-aliases/Selection.md b/docs/reference/type-aliases/Selection.md index 91b27b2a..484ad187 100644 --- a/docs/reference/type-aliases/Selection.md +++ b/docs/reference/type-aliases/Selection.md @@ -3,6 +3,8 @@ id: Selection title: Selection --- +# Type Alias: Selection\ + ```ts type Selection = Readable; ``` diff --git a/docs/reference/type-aliases/StoreAction.md b/docs/reference/type-aliases/StoreAction.md index 645ac1cd..1e839025 100644 --- a/docs/reference/type-aliases/StoreAction.md +++ b/docs/reference/type-aliases/StoreAction.md @@ -3,6 +3,8 @@ id: StoreAction title: StoreAction --- +# Type Alias: StoreAction() + ```ts type StoreAction = (...args) => any; ``` diff --git a/docs/reference/type-aliases/StoreActionMap.md b/docs/reference/type-aliases/StoreActionMap.md index fd5df617..5191c5f5 100644 --- a/docs/reference/type-aliases/StoreActionMap.md +++ b/docs/reference/type-aliases/StoreActionMap.md @@ -3,6 +3,8 @@ id: StoreActionMap title: StoreActionMap --- +# Type Alias: StoreActionMap + ```ts type StoreActionMap = Record; ``` diff --git a/docs/reference/type-aliases/StoreActionsFactory.md b/docs/reference/type-aliases/StoreActionsFactory.md index b22ccb91..b7caaee8 100644 --- a/docs/reference/type-aliases/StoreActionsFactory.md +++ b/docs/reference/type-aliases/StoreActionsFactory.md @@ -3,6 +3,8 @@ id: StoreActionsFactory title: StoreActionsFactory --- +# Type Alias: StoreActionsFactory()\ + ```ts type StoreActionsFactory = (store) => TActions; ``` From 27b705768d62a14aaf2f41e5d9660ce543f69d54 Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Thu, 10 Sep 2026 12:53:57 +0200 Subject: [PATCH 3/5] docs: keep generated page titles disabled --- .../angular/reference/functions/createStoreContext.md | 2 -- docs/framework/angular/reference/functions/injectAtom.md | 2 -- docs/framework/angular/reference/functions/injectSelector.md | 2 -- docs/framework/angular/reference/functions/injectStore-1.md | 2 -- docs/framework/angular/reference/functions/injectStore.md | 2 -- docs/framework/angular/reference/index.md | 2 -- .../angular/reference/interfaces/InjectSelectorOptions.md | 2 -- .../angular/reference/interfaces/WritableAtomSignal.md | 2 -- .../angular/reference/type-aliases/SelectionSource.md | 2 -- .../framework/octane/reference/functions/createStoreContext.md | 2 -- docs/framework/octane/reference/functions/useAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateStore.md | 2 -- docs/framework/octane/reference/functions/useSelector.md | 2 -- docs/framework/octane/reference/index.md | 2 -- .../octane/reference/interfaces/UseSelectorOptions.md | 2 -- .../framework/preact/reference/functions/createStoreContext.md | 2 -- docs/framework/preact/reference/functions/useAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateStore.md | 2 -- docs/framework/preact/reference/functions/useSelector.md | 2 -- docs/framework/preact/reference/functions/useStore-1.md | 2 -- docs/framework/preact/reference/functions/useStore.md | 2 -- docs/framework/preact/reference/index.md | 2 -- .../preact/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/react/reference/functions/createStoreContext.md | 2 -- docs/framework/react/reference/functions/useAtom.md | 2 -- docs/framework/react/reference/functions/useCreateAtom.md | 2 -- docs/framework/react/reference/functions/useCreateStore.md | 2 -- docs/framework/react/reference/functions/useSelector.md | 2 -- docs/framework/react/reference/functions/useStore-1.md | 2 -- docs/framework/react/reference/functions/useStore.md | 2 -- docs/framework/react/reference/index.md | 2 -- .../framework/react/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/solid/reference/functions/createStoreContext.md | 2 -- docs/framework/solid/reference/functions/useAtom.md | 2 -- docs/framework/solid/reference/functions/useSelector.md | 2 -- docs/framework/solid/reference/functions/useStore-1.md | 2 -- docs/framework/solid/reference/functions/useStore.md | 2 -- docs/framework/solid/reference/index.md | 2 -- .../framework/solid/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/svelte/reference/functions/useAtom.md | 2 -- docs/framework/svelte/reference/functions/useSelector.md | 2 -- docs/framework/svelte/reference/functions/useStore-1.md | 2 -- docs/framework/svelte/reference/functions/useStore.md | 2 -- docs/framework/svelte/reference/index.md | 2 -- .../svelte/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/vue/reference/functions/useAtom.md | 2 -- docs/framework/vue/reference/functions/useSelector.md | 2 -- docs/framework/vue/reference/functions/useStore-1.md | 2 -- docs/framework/vue/reference/functions/useStore.md | 2 -- docs/framework/vue/reference/index.md | 2 -- docs/framework/vue/reference/interfaces/UseSelectorOptions.md | 2 -- docs/reference/classes/ReadonlyStore.md | 2 -- docs/reference/classes/Store.md | 2 -- docs/reference/functions/batch.md | 2 -- docs/reference/functions/createAsyncAtom.md | 2 -- docs/reference/functions/createAtom.md | 2 -- docs/reference/functions/createStore.md | 2 -- docs/reference/functions/flush.md | 2 -- docs/reference/functions/shallow.md | 2 -- docs/reference/functions/toObserver.md | 2 -- docs/reference/index.md | 2 -- docs/reference/interfaces/Atom.md | 2 -- docs/reference/interfaces/AtomOptions.md | 2 -- docs/reference/interfaces/BaseAtom.md | 2 -- docs/reference/interfaces/InternalBaseAtom.md | 2 -- docs/reference/interfaces/InternalReadonlyAtom.md | 2 -- docs/reference/interfaces/InteropSubscribable.md | 2 -- docs/reference/interfaces/Readable.md | 2 -- docs/reference/interfaces/ReadonlyAtom.md | 2 -- docs/reference/interfaces/Subscribable.md | 2 -- docs/reference/interfaces/Subscription.md | 2 -- docs/reference/type-aliases/AnyAtom.md | 2 -- docs/reference/type-aliases/Observer.md | 2 -- docs/reference/type-aliases/Selection.md | 2 -- docs/reference/type-aliases/StoreAction.md | 2 -- docs/reference/type-aliases/StoreActionMap.md | 2 -- docs/reference/type-aliases/StoreActionsFactory.md | 2 -- typedoc.json | 3 +++ 80 files changed, 3 insertions(+), 158 deletions(-) create mode 100644 typedoc.json diff --git a/docs/framework/angular/reference/functions/createStoreContext.md b/docs/framework/angular/reference/functions/createStoreContext.md index 9d1a39a8..f79044fc 100644 --- a/docs/framework/angular/reference/functions/createStoreContext.md +++ b/docs/framework/angular/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/angular/reference/functions/injectAtom.md b/docs/framework/angular/reference/functions/injectAtom.md index 8d9bd6ef..e993c076 100644 --- a/docs/framework/angular/reference/functions/injectAtom.md +++ b/docs/framework/angular/reference/functions/injectAtom.md @@ -3,8 +3,6 @@ id: injectAtom title: injectAtom --- -# Function: injectAtom() - ```ts function injectAtom(atom, options?): WritableAtomSignal; ``` diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index a92e9bc2..baca3a87 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -3,8 +3,6 @@ id: injectSelector title: injectSelector --- -# Function: injectSelector() - ```ts function injectSelector( source, diff --git a/docs/framework/angular/reference/functions/injectStore-1.md b/docs/framework/angular/reference/functions/injectStore-1.md index 6e89cddc..8e693eb9 100644 --- a/docs/framework/angular/reference/functions/injectStore-1.md +++ b/docs/framework/angular/reference/functions/injectStore-1.md @@ -3,8 +3,6 @@ id: injectStore title: injectStore --- -# ~~Function: injectStore()~~ - ```ts function injectStore( store, diff --git a/docs/framework/angular/reference/functions/injectStore.md b/docs/framework/angular/reference/functions/injectStore.md index b88a398b..91347fb9 100644 --- a/docs/framework/angular/reference/functions/injectStore.md +++ b/docs/framework/angular/reference/functions/injectStore.md @@ -3,8 +3,6 @@ id: _injectStore title: _injectStore --- -# Function: \_injectStore() - ```ts function _injectStore( store, diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 294379cc..7b5d6475 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/angular-store" title: "@tanstack/angular-store" --- -# @tanstack/angular-store - ## Interfaces - [InjectSelectorOptions](interfaces/InjectSelectorOptions.md) diff --git a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md index 993b6db4..b20bb642 100644 --- a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md @@ -3,8 +3,6 @@ id: InjectSelectorOptions title: InjectSelectorOptions --- -# Interface: InjectSelectorOptions\ - Defined in: [packages/angular-store/src/injectSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectSelector.ts#L11) ## Extends diff --git a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md index ce3ea69a..b197a673 100644 --- a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md +++ b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md @@ -3,8 +3,6 @@ id: WritableAtomSignal title: WritableAtomSignal --- -# Interface: WritableAtomSignal()\ - Defined in: [packages/angular-store/src/injectAtom.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectAtom.ts#L21) A callable signal that reads the current atom value when invoked and diff --git a/docs/framework/angular/reference/type-aliases/SelectionSource.md b/docs/framework/angular/reference/type-aliases/SelectionSource.md index 03444a60..3079d7cb 100644 --- a/docs/framework/angular/reference/type-aliases/SelectionSource.md +++ b/docs/framework/angular/reference/type-aliases/SelectionSource.md @@ -3,8 +3,6 @@ id: SelectionSource title: SelectionSource --- -# Type Alias: SelectionSource\ - ```ts type SelectionSource = object; ``` diff --git a/docs/framework/octane/reference/functions/createStoreContext.md b/docs/framework/octane/reference/functions/createStoreContext.md index b9b0e95f..fd81065b 100644 --- a/docs/framework/octane/reference/functions/createStoreContext.md +++ b/docs/framework/octane/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/octane/reference/functions/useAtom.md b/docs/framework/octane/reference/functions/useAtom.md index 289b16e2..a2813ae0 100644 --- a/docs/framework/octane/reference/functions/useAtom.md +++ b/docs/framework/octane/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom( atom, diff --git a/docs/framework/octane/reference/functions/useCreateAtom.md b/docs/framework/octane/reference/functions/useCreateAtom.md index bdc41bad..ba1f7050 100644 --- a/docs/framework/octane/reference/functions/useCreateAtom.md +++ b/docs/framework/octane/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Readonly atom ```ts diff --git a/docs/framework/octane/reference/functions/useCreateStore.md b/docs/framework/octane/reference/functions/useCreateStore.md index 63b25fe9..a83bb350 100644 --- a/docs/framework/octane/reference/functions/useCreateStore.md +++ b/docs/framework/octane/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Readonly store ```ts diff --git a/docs/framework/octane/reference/functions/useSelector.md b/docs/framework/octane/reference/functions/useSelector.md index a6093657..610792ff 100644 --- a/docs/framework/octane/reference/functions/useSelector.md +++ b/docs/framework/octane/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/octane/reference/index.md b/docs/framework/octane/reference/index.md index 7dbc161c..85438412 100644 --- a/docs/framework/octane/reference/index.md +++ b/docs/framework/octane/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/octane-store" title: "@tanstack/octane-store" --- -# @tanstack/octane-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md index 7f3d33a5..744df62b 100644 --- a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [octane-store/src/useSelector.ts:5](https://github.com/TanStack/store/blob/main/packages/octane-store/src/useSelector.ts#L5) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md index bfc21a03..c7312462 100644 --- a/docs/framework/preact/reference/functions/createStoreContext.md +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md index 9a0daab4..ca7b82ff 100644 --- a/docs/framework/preact/reference/functions/useAtom.md +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md index a92253d0..5eae73c6 100644 --- a/docs/framework/preact/reference/functions/useCreateAtom.md +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md index 56b8f91c..3345e513 100644 --- a/docs/framework/preact/reference/functions/useCreateStore.md +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md index fe1036b3..9ecae133 100644 --- a/docs/framework/preact/reference/functions/useSelector.md +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/preact/reference/functions/useStore-1.md b/docs/framework/preact/reference/functions/useStore-1.md index 9b45156b..1e0e5fa1 100644 --- a/docs/framework/preact/reference/functions/useStore-1.md +++ b/docs/framework/preact/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md index ecfcbe95..da7e2808 100644 --- a/docs/framework/preact/reference/functions/useStore.md +++ b/docs/framework/preact/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index 76afd2bf..fc75d0df 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/preact-store" title: "@tanstack/preact-store" --- -# @tanstack/preact-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md index b3a6fa5e..432ad10c 100644 --- a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createStoreContext.md b/docs/framework/react/reference/functions/createStoreContext.md index c7bfe786..9c81832c 100644 --- a/docs/framework/react/reference/functions/createStoreContext.md +++ b/docs/framework/react/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/react/reference/functions/useAtom.md b/docs/framework/react/reference/functions/useAtom.md index 5cd2eb68..bee705db 100644 --- a/docs/framework/react/reference/functions/useAtom.md +++ b/docs/framework/react/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/react/reference/functions/useCreateAtom.md b/docs/framework/react/reference/functions/useCreateAtom.md index 1b6cfaab..eb5db9fa 100644 --- a/docs/framework/react/reference/functions/useCreateAtom.md +++ b/docs/framework/react/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useCreateStore.md b/docs/framework/react/reference/functions/useCreateStore.md index f01d05ba..07acc257 100644 --- a/docs/framework/react/reference/functions/useCreateStore.md +++ b/docs/framework/react/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useSelector.md b/docs/framework/react/reference/functions/useSelector.md index 4eb73ea7..e4035fbd 100644 --- a/docs/framework/react/reference/functions/useSelector.md +++ b/docs/framework/react/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/react/reference/functions/useStore-1.md b/docs/framework/react/reference/functions/useStore-1.md index 76506468..cfc238f7 100644 --- a/docs/framework/react/reference/functions/useStore-1.md +++ b/docs/framework/react/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/react/reference/functions/useStore.md b/docs/framework/react/reference/functions/useStore.md index bbc43c6b..3ca150f3 100644 --- a/docs/framework/react/reference/functions/useStore.md +++ b/docs/framework/react/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 957bf4c4..4900ddfe 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/react-store" title: "@tanstack/react-store" --- -# @tanstack/react-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/react/reference/interfaces/UseSelectorOptions.md b/docs/framework/react/reference/interfaces/UseSelectorOptions.md index efaa91df..551e84f7 100644 --- a/docs/framework/react/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/react/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [packages/react-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/react-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createStoreContext.md b/docs/framework/solid/reference/functions/createStoreContext.md index 2ff36e6d..41ddddfe 100644 --- a/docs/framework/solid/reference/functions/createStoreContext.md +++ b/docs/framework/solid/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/solid/reference/functions/useAtom.md b/docs/framework/solid/reference/functions/useAtom.md index a05c4337..e40a43e9 100644 --- a/docs/framework/solid/reference/functions/useAtom.md +++ b/docs/framework/solid/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Accessor, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/solid/reference/functions/useSelector.md b/docs/framework/solid/reference/functions/useSelector.md index ed6f3961..4a674915 100644 --- a/docs/framework/solid/reference/functions/useSelector.md +++ b/docs/framework/solid/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/solid/reference/functions/useStore-1.md b/docs/framework/solid/reference/functions/useStore-1.md index e51f0ccb..4f3abc94 100644 --- a/docs/framework/solid/reference/functions/useStore-1.md +++ b/docs/framework/solid/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/solid/reference/functions/useStore.md b/docs/framework/solid/reference/functions/useStore.md index 046e7a04..b1ffe800 100644 --- a/docs/framework/solid/reference/functions/useStore.md +++ b/docs/framework/solid/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index bfe6ce88..45eda670 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/solid-store" title: "@tanstack/solid-store" --- -# @tanstack/solid-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md index 2d3845b8..82da6866 100644 --- a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [solid-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/solid-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/useAtom.md b/docs/framework/svelte/reference/functions/useAtom.md index 727d42bb..6e16b4d2 100644 --- a/docs/framework/svelte/reference/functions/useAtom.md +++ b/docs/framework/svelte/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [{ current: TValue; diff --git a/docs/framework/svelte/reference/functions/useSelector.md b/docs/framework/svelte/reference/functions/useSelector.md index a0abbb21..6e65346e 100644 --- a/docs/framework/svelte/reference/functions/useSelector.md +++ b/docs/framework/svelte/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/svelte/reference/functions/useStore-1.md b/docs/framework/svelte/reference/functions/useStore-1.md index b3d49758..50133785 100644 --- a/docs/framework/svelte/reference/functions/useStore-1.md +++ b/docs/framework/svelte/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/svelte/reference/functions/useStore.md b/docs/framework/svelte/reference/functions/useStore.md index 8de580f1..5499b29c 100644 --- a/docs/framework/svelte/reference/functions/useStore.md +++ b/docs/framework/svelte/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 531a5c99..39f4071a 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/svelte-store" title: "@tanstack/svelte-store" --- -# @tanstack/svelte-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md index 6dfeceff..a1287ba6 100644 --- a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [svelte-store/src/useSelector.svelte.ts:3](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/useSelector.svelte.ts#L3) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md index 6b598d89..1ba41a97 100644 --- a/docs/framework/vue/reference/functions/useAtom.md +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md index adc70581..eb1fc8e2 100644 --- a/docs/framework/vue/reference/functions/useSelector.md +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/vue/reference/functions/useStore-1.md b/docs/framework/vue/reference/functions/useStore-1.md index a96bb61e..f7f6be01 100644 --- a/docs/framework/vue/reference/functions/useStore-1.md +++ b/docs/framework/vue/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md index 0a14ea38..98f104ac 100644 --- a/docs/framework/vue/reference/functions/useStore.md +++ b/docs/framework/vue/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index cc4e9333..6f5d5f42 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/vue-store" title: "@tanstack/vue-store" --- -# @tanstack/vue-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md index dc0616ce..2838e456 100644 --- a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [vue-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/vue-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/reference/classes/ReadonlyStore.md b/docs/reference/classes/ReadonlyStore.md index e23ee15c..97dd2e88 100644 --- a/docs/reference/classes/ReadonlyStore.md +++ b/docs/reference/classes/ReadonlyStore.md @@ -3,8 +3,6 @@ id: ReadonlyStore title: ReadonlyStore --- -# Class: ReadonlyStore\ - Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59) ## Type Parameters diff --git a/docs/reference/classes/Store.md b/docs/reference/classes/Store.md index 346926a3..7d0eab2c 100644 --- a/docs/reference/classes/Store.md +++ b/docs/reference/classes/Store.md @@ -3,8 +3,6 @@ id: Store title: Store --- -# Class: Store\ - Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15) ## Type Parameters diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index f3de25ce..43c3f38e 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -3,8 +3,6 @@ id: batch title: batch --- -# Function: batch() - ```ts function batch(fn): void; ``` diff --git a/docs/reference/functions/createAsyncAtom.md b/docs/reference/functions/createAsyncAtom.md index 828bfce8..4bf0c602 100644 --- a/docs/reference/functions/createAsyncAtom.md +++ b/docs/reference/functions/createAsyncAtom.md @@ -3,8 +3,6 @@ id: createAsyncAtom title: createAsyncAtom --- -# Function: createAsyncAtom() - ```ts function createAsyncAtom(getValue, options?): ReadonlyAtom>; ``` diff --git a/docs/reference/functions/createAtom.md b/docs/reference/functions/createAtom.md index 79dce560..eed96287 100644 --- a/docs/reference/functions/createAtom.md +++ b/docs/reference/functions/createAtom.md @@ -3,8 +3,6 @@ id: createAtom title: createAtom --- -# Function: createAtom() - ## Call Signature ```ts diff --git a/docs/reference/functions/createStore.md b/docs/reference/functions/createStore.md index 8c211275..827f47e2 100644 --- a/docs/reference/functions/createStore.md +++ b/docs/reference/functions/createStore.md @@ -3,8 +3,6 @@ id: createStore title: createStore --- -# Function: createStore() - ## Call Signature ```ts diff --git a/docs/reference/functions/flush.md b/docs/reference/functions/flush.md index 37ab69a8..4e1ef6c9 100644 --- a/docs/reference/functions/flush.md +++ b/docs/reference/functions/flush.md @@ -3,8 +3,6 @@ id: flush title: flush --- -# Function: flush() - ```ts function flush(): void; ``` diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md index fb3b313a..e371f8c1 100644 --- a/docs/reference/functions/shallow.md +++ b/docs/reference/functions/shallow.md @@ -3,8 +3,6 @@ id: shallow title: shallow --- -# Function: shallow() - ```ts function shallow(objA, objB): boolean; ``` diff --git a/docs/reference/functions/toObserver.md b/docs/reference/functions/toObserver.md index 67cf733b..b303332c 100644 --- a/docs/reference/functions/toObserver.md +++ b/docs/reference/functions/toObserver.md @@ -3,8 +3,6 @@ id: toObserver title: toObserver --- -# Function: toObserver() - ```ts function toObserver( nextHandler?, diff --git a/docs/reference/index.md b/docs/reference/index.md index afc8e5dd..9ef00a64 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/store" title: "@tanstack/store" --- -# @tanstack/store - ## Classes - [ReadonlyStore](classes/ReadonlyStore.md) diff --git a/docs/reference/interfaces/Atom.md b/docs/reference/interfaces/Atom.md index 63124fd2..279539e7 100644 --- a/docs/reference/interfaces/Atom.md +++ b/docs/reference/interfaces/Atom.md @@ -3,8 +3,6 @@ id: Atom title: Atom --- -# Interface: Atom\ - Defined in: [types.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L42) ## Extends diff --git a/docs/reference/interfaces/AtomOptions.md b/docs/reference/interfaces/AtomOptions.md index c05fee8d..1d7e29cd 100644 --- a/docs/reference/interfaces/AtomOptions.md +++ b/docs/reference/interfaces/AtomOptions.md @@ -3,8 +3,6 @@ id: AtomOptions title: AtomOptions --- -# Interface: AtomOptions\ - Defined in: [types.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L47) ## Type Parameters diff --git a/docs/reference/interfaces/BaseAtom.md b/docs/reference/interfaces/BaseAtom.md index 57de2ed9..8a2a0c47 100644 --- a/docs/reference/interfaces/BaseAtom.md +++ b/docs/reference/interfaces/BaseAtom.md @@ -3,8 +3,6 @@ id: BaseAtom title: BaseAtom --- -# Interface: BaseAtom\ - Defined in: [types.ts:33](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L33) ## Extends diff --git a/docs/reference/interfaces/InternalBaseAtom.md b/docs/reference/interfaces/InternalBaseAtom.md index b2716e81..33fd0bd7 100644 --- a/docs/reference/interfaces/InternalBaseAtom.md +++ b/docs/reference/interfaces/InternalBaseAtom.md @@ -3,8 +3,6 @@ id: InternalBaseAtom title: InternalBaseAtom --- -# Interface: InternalBaseAtom\ - Defined in: [types.ts:35](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L35) ## Extends diff --git a/docs/reference/interfaces/InternalReadonlyAtom.md b/docs/reference/interfaces/InternalReadonlyAtom.md index defd840e..44632117 100644 --- a/docs/reference/interfaces/InternalReadonlyAtom.md +++ b/docs/reference/interfaces/InternalReadonlyAtom.md @@ -3,8 +3,6 @@ id: InternalReadonlyAtom title: InternalReadonlyAtom --- -# Interface: InternalReadonlyAtom\ - Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53) ## Extends diff --git a/docs/reference/interfaces/InteropSubscribable.md b/docs/reference/interfaces/InteropSubscribable.md index 45c4cea3..f3dad5e5 100644 --- a/docs/reference/interfaces/InteropSubscribable.md +++ b/docs/reference/interfaces/InteropSubscribable.md @@ -3,8 +3,6 @@ id: InteropSubscribable title: InteropSubscribable --- -# Interface: InteropSubscribable\ - Defined in: [types.ts:5](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L5) ## Extended by diff --git a/docs/reference/interfaces/Readable.md b/docs/reference/interfaces/Readable.md index 96f344b1..e9e84490 100644 --- a/docs/reference/interfaces/Readable.md +++ b/docs/reference/interfaces/Readable.md @@ -3,8 +3,6 @@ id: Readable title: Readable --- -# Interface: Readable\ - Defined in: [types.ts:29](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L29) ## Extends diff --git a/docs/reference/interfaces/ReadonlyAtom.md b/docs/reference/interfaces/ReadonlyAtom.md index 2aeaa860..bc98e2de 100644 --- a/docs/reference/interfaces/ReadonlyAtom.md +++ b/docs/reference/interfaces/ReadonlyAtom.md @@ -3,8 +3,6 @@ id: ReadonlyAtom title: ReadonlyAtom --- -# Interface: ReadonlyAtom\ - Defined in: [types.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L67) An atom that is read-only and cannot be set. diff --git a/docs/reference/interfaces/Subscribable.md b/docs/reference/interfaces/Subscribable.md index 0857be0c..c15ec4b5 100644 --- a/docs/reference/interfaces/Subscribable.md +++ b/docs/reference/interfaces/Subscribable.md @@ -3,8 +3,6 @@ id: Subscribable title: Subscribable --- -# Interface: Subscribable\ - Defined in: [types.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L20) ## Extends diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index 5ddc5fba..d258cd39 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -3,8 +3,6 @@ id: Subscription title: Subscription --- -# Interface: Subscription - Defined in: [types.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L16) ## Properties diff --git a/docs/reference/type-aliases/AnyAtom.md b/docs/reference/type-aliases/AnyAtom.md index d41e125c..eb2c7dbd 100644 --- a/docs/reference/type-aliases/AnyAtom.md +++ b/docs/reference/type-aliases/AnyAtom.md @@ -3,8 +3,6 @@ id: AnyAtom title: AnyAtom --- -# Type Alias: AnyAtom - ```ts type AnyAtom = BaseAtom; ``` diff --git a/docs/reference/type-aliases/Observer.md b/docs/reference/type-aliases/Observer.md index 47cd75dd..65f901b7 100644 --- a/docs/reference/type-aliases/Observer.md +++ b/docs/reference/type-aliases/Observer.md @@ -3,8 +3,6 @@ id: Observer title: Observer --- -# Type Alias: Observer\ - ```ts type Observer = object; ``` diff --git a/docs/reference/type-aliases/Selection.md b/docs/reference/type-aliases/Selection.md index 484ad187..91b27b2a 100644 --- a/docs/reference/type-aliases/Selection.md +++ b/docs/reference/type-aliases/Selection.md @@ -3,8 +3,6 @@ id: Selection title: Selection --- -# Type Alias: Selection\ - ```ts type Selection = Readable; ``` diff --git a/docs/reference/type-aliases/StoreAction.md b/docs/reference/type-aliases/StoreAction.md index 1e839025..645ac1cd 100644 --- a/docs/reference/type-aliases/StoreAction.md +++ b/docs/reference/type-aliases/StoreAction.md @@ -3,8 +3,6 @@ id: StoreAction title: StoreAction --- -# Type Alias: StoreAction() - ```ts type StoreAction = (...args) => any; ``` diff --git a/docs/reference/type-aliases/StoreActionMap.md b/docs/reference/type-aliases/StoreActionMap.md index 5191c5f5..fd5df617 100644 --- a/docs/reference/type-aliases/StoreActionMap.md +++ b/docs/reference/type-aliases/StoreActionMap.md @@ -3,8 +3,6 @@ id: StoreActionMap title: StoreActionMap --- -# Type Alias: StoreActionMap - ```ts type StoreActionMap = Record; ``` diff --git a/docs/reference/type-aliases/StoreActionsFactory.md b/docs/reference/type-aliases/StoreActionsFactory.md index b7caaee8..b22ccb91 100644 --- a/docs/reference/type-aliases/StoreActionsFactory.md +++ b/docs/reference/type-aliases/StoreActionsFactory.md @@ -3,8 +3,6 @@ id: StoreActionsFactory title: StoreActionsFactory --- -# Type Alias: StoreActionsFactory()\ - ```ts type StoreActionsFactory = (store) => TActions; ``` diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..3bd16c29 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,3 @@ +{ + "hidePageTitle": true +} From 5903a575d3daa125992aab2175e993da18343b2c Mon Sep 17 00:00:00 2001 From: Kevin Van Cott Date: Thu, 10 Sep 2026 12:56:27 +0200 Subject: [PATCH 4/5] docs: leave API reference output to the generator --- .../framework/angular/reference/functions/createStoreContext.md | 2 ++ docs/framework/angular/reference/functions/injectAtom.md | 2 ++ docs/framework/angular/reference/functions/injectSelector.md | 2 ++ docs/framework/angular/reference/functions/injectStore-1.md | 2 ++ docs/framework/angular/reference/functions/injectStore.md | 2 ++ docs/framework/angular/reference/index.md | 2 ++ .../angular/reference/interfaces/InjectSelectorOptions.md | 2 ++ .../angular/reference/interfaces/WritableAtomSignal.md | 2 ++ .../framework/angular/reference/type-aliases/SelectionSource.md | 2 ++ docs/framework/octane/reference/functions/createStoreContext.md | 2 ++ docs/framework/octane/reference/functions/useAtom.md | 2 ++ docs/framework/octane/reference/functions/useCreateAtom.md | 2 ++ docs/framework/octane/reference/functions/useCreateStore.md | 2 ++ docs/framework/octane/reference/functions/useSelector.md | 2 ++ docs/framework/octane/reference/index.md | 2 ++ .../framework/octane/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/preact/reference/functions/createStoreContext.md | 2 ++ docs/framework/preact/reference/functions/useAtom.md | 2 ++ docs/framework/preact/reference/functions/useCreateAtom.md | 2 ++ docs/framework/preact/reference/functions/useCreateStore.md | 2 ++ docs/framework/preact/reference/functions/useSelector.md | 2 ++ docs/framework/preact/reference/functions/useStore-1.md | 2 ++ docs/framework/preact/reference/functions/useStore.md | 2 ++ docs/framework/preact/reference/index.md | 2 ++ .../framework/preact/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/react/reference/functions/createStoreContext.md | 2 ++ docs/framework/react/reference/functions/useAtom.md | 2 ++ docs/framework/react/reference/functions/useCreateAtom.md | 2 ++ docs/framework/react/reference/functions/useCreateStore.md | 2 ++ docs/framework/react/reference/functions/useSelector.md | 2 ++ docs/framework/react/reference/functions/useStore-1.md | 2 ++ docs/framework/react/reference/functions/useStore.md | 2 ++ docs/framework/react/reference/index.md | 2 ++ docs/framework/react/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/solid/reference/functions/createStoreContext.md | 2 ++ docs/framework/solid/reference/functions/useAtom.md | 2 ++ docs/framework/solid/reference/functions/useSelector.md | 2 ++ docs/framework/solid/reference/functions/useStore-1.md | 2 ++ docs/framework/solid/reference/functions/useStore.md | 2 ++ docs/framework/solid/reference/index.md | 2 ++ docs/framework/solid/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/svelte/reference/functions/useAtom.md | 2 ++ docs/framework/svelte/reference/functions/useSelector.md | 2 ++ docs/framework/svelte/reference/functions/useStore-1.md | 2 ++ docs/framework/svelte/reference/functions/useStore.md | 2 ++ docs/framework/svelte/reference/index.md | 2 ++ .../framework/svelte/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/framework/vue/reference/functions/useAtom.md | 2 ++ docs/framework/vue/reference/functions/useSelector.md | 2 ++ docs/framework/vue/reference/functions/useStore-1.md | 2 ++ docs/framework/vue/reference/functions/useStore.md | 2 ++ docs/framework/vue/reference/index.md | 2 ++ docs/framework/vue/reference/interfaces/UseSelectorOptions.md | 2 ++ docs/reference/classes/ReadonlyStore.md | 2 ++ docs/reference/classes/Store.md | 2 ++ docs/reference/functions/batch.md | 2 ++ docs/reference/functions/createAsyncAtom.md | 2 ++ docs/reference/functions/createAtom.md | 2 ++ docs/reference/functions/createStore.md | 2 ++ docs/reference/functions/flush.md | 2 ++ docs/reference/functions/shallow.md | 2 ++ docs/reference/functions/toObserver.md | 2 ++ docs/reference/index.md | 2 ++ docs/reference/interfaces/Atom.md | 2 ++ docs/reference/interfaces/AtomOptions.md | 2 ++ docs/reference/interfaces/BaseAtom.md | 2 ++ docs/reference/interfaces/InternalBaseAtom.md | 2 ++ docs/reference/interfaces/InternalReadonlyAtom.md | 2 ++ docs/reference/interfaces/InteropSubscribable.md | 2 ++ docs/reference/interfaces/Readable.md | 2 ++ docs/reference/interfaces/ReadonlyAtom.md | 2 ++ docs/reference/interfaces/Subscribable.md | 2 ++ docs/reference/interfaces/Subscription.md | 2 ++ docs/reference/type-aliases/AnyAtom.md | 2 ++ docs/reference/type-aliases/Observer.md | 2 ++ docs/reference/type-aliases/Selection.md | 2 ++ docs/reference/type-aliases/StoreAction.md | 2 ++ docs/reference/type-aliases/StoreActionMap.md | 2 ++ docs/reference/type-aliases/StoreActionsFactory.md | 2 ++ 79 files changed, 158 insertions(+) diff --git a/docs/framework/angular/reference/functions/createStoreContext.md b/docs/framework/angular/reference/functions/createStoreContext.md index f79044fc..9d1a39a8 100644 --- a/docs/framework/angular/reference/functions/createStoreContext.md +++ b/docs/framework/angular/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/angular/reference/functions/injectAtom.md b/docs/framework/angular/reference/functions/injectAtom.md index e993c076..8d9bd6ef 100644 --- a/docs/framework/angular/reference/functions/injectAtom.md +++ b/docs/framework/angular/reference/functions/injectAtom.md @@ -3,6 +3,8 @@ id: injectAtom title: injectAtom --- +# Function: injectAtom() + ```ts function injectAtom(atom, options?): WritableAtomSignal; ``` diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index baca3a87..a92e9bc2 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -3,6 +3,8 @@ id: injectSelector title: injectSelector --- +# Function: injectSelector() + ```ts function injectSelector( source, diff --git a/docs/framework/angular/reference/functions/injectStore-1.md b/docs/framework/angular/reference/functions/injectStore-1.md index 8e693eb9..6e89cddc 100644 --- a/docs/framework/angular/reference/functions/injectStore-1.md +++ b/docs/framework/angular/reference/functions/injectStore-1.md @@ -3,6 +3,8 @@ id: injectStore title: injectStore --- +# ~~Function: injectStore()~~ + ```ts function injectStore( store, diff --git a/docs/framework/angular/reference/functions/injectStore.md b/docs/framework/angular/reference/functions/injectStore.md index 91347fb9..b88a398b 100644 --- a/docs/framework/angular/reference/functions/injectStore.md +++ b/docs/framework/angular/reference/functions/injectStore.md @@ -3,6 +3,8 @@ id: _injectStore title: _injectStore --- +# Function: \_injectStore() + ```ts function _injectStore( store, diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 7b5d6475..294379cc 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/angular-store" title: "@tanstack/angular-store" --- +# @tanstack/angular-store + ## Interfaces - [InjectSelectorOptions](interfaces/InjectSelectorOptions.md) diff --git a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md index b20bb642..993b6db4 100644 --- a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md @@ -3,6 +3,8 @@ id: InjectSelectorOptions title: InjectSelectorOptions --- +# Interface: InjectSelectorOptions\ + Defined in: [packages/angular-store/src/injectSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectSelector.ts#L11) ## Extends diff --git a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md index b197a673..ce3ea69a 100644 --- a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md +++ b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md @@ -3,6 +3,8 @@ id: WritableAtomSignal title: WritableAtomSignal --- +# Interface: WritableAtomSignal()\ + Defined in: [packages/angular-store/src/injectAtom.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectAtom.ts#L21) A callable signal that reads the current atom value when invoked and diff --git a/docs/framework/angular/reference/type-aliases/SelectionSource.md b/docs/framework/angular/reference/type-aliases/SelectionSource.md index 3079d7cb..03444a60 100644 --- a/docs/framework/angular/reference/type-aliases/SelectionSource.md +++ b/docs/framework/angular/reference/type-aliases/SelectionSource.md @@ -3,6 +3,8 @@ id: SelectionSource title: SelectionSource --- +# Type Alias: SelectionSource\ + ```ts type SelectionSource = object; ``` diff --git a/docs/framework/octane/reference/functions/createStoreContext.md b/docs/framework/octane/reference/functions/createStoreContext.md index fd81065b..b9b0e95f 100644 --- a/docs/framework/octane/reference/functions/createStoreContext.md +++ b/docs/framework/octane/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/octane/reference/functions/useAtom.md b/docs/framework/octane/reference/functions/useAtom.md index a2813ae0..289b16e2 100644 --- a/docs/framework/octane/reference/functions/useAtom.md +++ b/docs/framework/octane/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom( atom, diff --git a/docs/framework/octane/reference/functions/useCreateAtom.md b/docs/framework/octane/reference/functions/useCreateAtom.md index ba1f7050..bdc41bad 100644 --- a/docs/framework/octane/reference/functions/useCreateAtom.md +++ b/docs/framework/octane/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Readonly atom ```ts diff --git a/docs/framework/octane/reference/functions/useCreateStore.md b/docs/framework/octane/reference/functions/useCreateStore.md index a83bb350..63b25fe9 100644 --- a/docs/framework/octane/reference/functions/useCreateStore.md +++ b/docs/framework/octane/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Readonly store ```ts diff --git a/docs/framework/octane/reference/functions/useSelector.md b/docs/framework/octane/reference/functions/useSelector.md index 610792ff..a6093657 100644 --- a/docs/framework/octane/reference/functions/useSelector.md +++ b/docs/framework/octane/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/octane/reference/index.md b/docs/framework/octane/reference/index.md index 85438412..7dbc161c 100644 --- a/docs/framework/octane/reference/index.md +++ b/docs/framework/octane/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/octane-store" title: "@tanstack/octane-store" --- +# @tanstack/octane-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md index 744df62b..7f3d33a5 100644 --- a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [octane-store/src/useSelector.ts:5](https://github.com/TanStack/store/blob/main/packages/octane-store/src/useSelector.ts#L5) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md index c7312462..bfc21a03 100644 --- a/docs/framework/preact/reference/functions/createStoreContext.md +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md index ca7b82ff..9a0daab4 100644 --- a/docs/framework/preact/reference/functions/useAtom.md +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md index 5eae73c6..a92253d0 100644 --- a/docs/framework/preact/reference/functions/useCreateAtom.md +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md index 3345e513..56b8f91c 100644 --- a/docs/framework/preact/reference/functions/useCreateStore.md +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md index 9ecae133..fe1036b3 100644 --- a/docs/framework/preact/reference/functions/useSelector.md +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/preact/reference/functions/useStore-1.md b/docs/framework/preact/reference/functions/useStore-1.md index 1e0e5fa1..9b45156b 100644 --- a/docs/framework/preact/reference/functions/useStore-1.md +++ b/docs/framework/preact/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md index da7e2808..ecfcbe95 100644 --- a/docs/framework/preact/reference/functions/useStore.md +++ b/docs/framework/preact/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index fc75d0df..76afd2bf 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/preact-store" title: "@tanstack/preact-store" --- +# @tanstack/preact-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md index 432ad10c..b3a6fa5e 100644 --- a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createStoreContext.md b/docs/framework/react/reference/functions/createStoreContext.md index 9c81832c..c7bfe786 100644 --- a/docs/framework/react/reference/functions/createStoreContext.md +++ b/docs/framework/react/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/react/reference/functions/useAtom.md b/docs/framework/react/reference/functions/useAtom.md index bee705db..5cd2eb68 100644 --- a/docs/framework/react/reference/functions/useAtom.md +++ b/docs/framework/react/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/react/reference/functions/useCreateAtom.md b/docs/framework/react/reference/functions/useCreateAtom.md index eb5db9fa..1b6cfaab 100644 --- a/docs/framework/react/reference/functions/useCreateAtom.md +++ b/docs/framework/react/reference/functions/useCreateAtom.md @@ -3,6 +3,8 @@ id: useCreateAtom title: useCreateAtom --- +# Function: useCreateAtom() + ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useCreateStore.md b/docs/framework/react/reference/functions/useCreateStore.md index 07acc257..f01d05ba 100644 --- a/docs/framework/react/reference/functions/useCreateStore.md +++ b/docs/framework/react/reference/functions/useCreateStore.md @@ -3,6 +3,8 @@ id: useCreateStore title: useCreateStore --- +# Function: useCreateStore() + ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useSelector.md b/docs/framework/react/reference/functions/useSelector.md index e4035fbd..4eb73ea7 100644 --- a/docs/framework/react/reference/functions/useSelector.md +++ b/docs/framework/react/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/react/reference/functions/useStore-1.md b/docs/framework/react/reference/functions/useStore-1.md index cfc238f7..76506468 100644 --- a/docs/framework/react/reference/functions/useStore-1.md +++ b/docs/framework/react/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/react/reference/functions/useStore.md b/docs/framework/react/reference/functions/useStore.md index 3ca150f3..bbc43c6b 100644 --- a/docs/framework/react/reference/functions/useStore.md +++ b/docs/framework/react/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 4900ddfe..957bf4c4 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/react-store" title: "@tanstack/react-store" --- +# @tanstack/react-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/react/reference/interfaces/UseSelectorOptions.md b/docs/framework/react/reference/interfaces/UseSelectorOptions.md index 551e84f7..efaa91df 100644 --- a/docs/framework/react/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/react/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [packages/react-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/react-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createStoreContext.md b/docs/framework/solid/reference/functions/createStoreContext.md index 41ddddfe..2ff36e6d 100644 --- a/docs/framework/solid/reference/functions/createStoreContext.md +++ b/docs/framework/solid/reference/functions/createStoreContext.md @@ -3,6 +3,8 @@ id: createStoreContext title: createStoreContext --- +# Function: createStoreContext() + ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/solid/reference/functions/useAtom.md b/docs/framework/solid/reference/functions/useAtom.md index e40a43e9..a05c4337 100644 --- a/docs/framework/solid/reference/functions/useAtom.md +++ b/docs/framework/solid/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [Accessor, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/solid/reference/functions/useSelector.md b/docs/framework/solid/reference/functions/useSelector.md index 4a674915..ed6f3961 100644 --- a/docs/framework/solid/reference/functions/useSelector.md +++ b/docs/framework/solid/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/solid/reference/functions/useStore-1.md b/docs/framework/solid/reference/functions/useStore-1.md index 4f3abc94..e51f0ccb 100644 --- a/docs/framework/solid/reference/functions/useStore-1.md +++ b/docs/framework/solid/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/solid/reference/functions/useStore.md b/docs/framework/solid/reference/functions/useStore.md index b1ffe800..046e7a04 100644 --- a/docs/framework/solid/reference/functions/useStore.md +++ b/docs/framework/solid/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index 45eda670..bfe6ce88 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/solid-store" title: "@tanstack/solid-store" --- +# @tanstack/solid-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md index 82da6866..2d3845b8 100644 --- a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [solid-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/solid-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/useAtom.md b/docs/framework/svelte/reference/functions/useAtom.md index 6e16b4d2..727d42bb 100644 --- a/docs/framework/svelte/reference/functions/useAtom.md +++ b/docs/framework/svelte/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [{ current: TValue; diff --git a/docs/framework/svelte/reference/functions/useSelector.md b/docs/framework/svelte/reference/functions/useSelector.md index 6e65346e..a0abbb21 100644 --- a/docs/framework/svelte/reference/functions/useSelector.md +++ b/docs/framework/svelte/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/svelte/reference/functions/useStore-1.md b/docs/framework/svelte/reference/functions/useStore-1.md index 50133785..b3d49758 100644 --- a/docs/framework/svelte/reference/functions/useStore-1.md +++ b/docs/framework/svelte/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/svelte/reference/functions/useStore.md b/docs/framework/svelte/reference/functions/useStore.md index 5499b29c..8de580f1 100644 --- a/docs/framework/svelte/reference/functions/useStore.md +++ b/docs/framework/svelte/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 39f4071a..531a5c99 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/svelte-store" title: "@tanstack/svelte-store" --- +# @tanstack/svelte-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md index a1287ba6..6dfeceff 100644 --- a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [svelte-store/src/useSelector.svelte.ts:3](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/useSelector.svelte.ts#L3) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md index 1ba41a97..6b598d89 100644 --- a/docs/framework/vue/reference/functions/useAtom.md +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -3,6 +3,8 @@ id: useAtom title: useAtom --- +# Function: useAtom() + ```ts function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md index eb1fc8e2..adc70581 100644 --- a/docs/framework/vue/reference/functions/useSelector.md +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -3,6 +3,8 @@ id: useSelector title: useSelector --- +# Function: useSelector() + ```ts function useSelector( source, diff --git a/docs/framework/vue/reference/functions/useStore-1.md b/docs/framework/vue/reference/functions/useStore-1.md index f7f6be01..a96bb61e 100644 --- a/docs/framework/vue/reference/functions/useStore-1.md +++ b/docs/framework/vue/reference/functions/useStore-1.md @@ -3,6 +3,8 @@ id: useStore title: useStore --- +# ~~Function: useStore()~~ + ```ts function useStore( source, diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md index 98f104ac..0a14ea38 100644 --- a/docs/framework/vue/reference/functions/useStore.md +++ b/docs/framework/vue/reference/functions/useStore.md @@ -3,6 +3,8 @@ id: _useStore title: _useStore --- +# Function: \_useStore() + ```ts function _useStore( store, diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index 6f5d5f42..cc4e9333 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/vue-store" title: "@tanstack/vue-store" --- +# @tanstack/vue-store + ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md index 2838e456..dc0616ce 100644 --- a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -3,6 +3,8 @@ id: UseSelectorOptions title: UseSelectorOptions --- +# Interface: UseSelectorOptions\ + Defined in: [vue-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/vue-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/reference/classes/ReadonlyStore.md b/docs/reference/classes/ReadonlyStore.md index 97dd2e88..e23ee15c 100644 --- a/docs/reference/classes/ReadonlyStore.md +++ b/docs/reference/classes/ReadonlyStore.md @@ -3,6 +3,8 @@ id: ReadonlyStore title: ReadonlyStore --- +# Class: ReadonlyStore\ + Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59) ## Type Parameters diff --git a/docs/reference/classes/Store.md b/docs/reference/classes/Store.md index 7d0eab2c..346926a3 100644 --- a/docs/reference/classes/Store.md +++ b/docs/reference/classes/Store.md @@ -3,6 +3,8 @@ id: Store title: Store --- +# Class: Store\ + Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15) ## Type Parameters diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index 43c3f38e..f3de25ce 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -3,6 +3,8 @@ id: batch title: batch --- +# Function: batch() + ```ts function batch(fn): void; ``` diff --git a/docs/reference/functions/createAsyncAtom.md b/docs/reference/functions/createAsyncAtom.md index 4bf0c602..828bfce8 100644 --- a/docs/reference/functions/createAsyncAtom.md +++ b/docs/reference/functions/createAsyncAtom.md @@ -3,6 +3,8 @@ id: createAsyncAtom title: createAsyncAtom --- +# Function: createAsyncAtom() + ```ts function createAsyncAtom(getValue, options?): ReadonlyAtom>; ``` diff --git a/docs/reference/functions/createAtom.md b/docs/reference/functions/createAtom.md index eed96287..79dce560 100644 --- a/docs/reference/functions/createAtom.md +++ b/docs/reference/functions/createAtom.md @@ -3,6 +3,8 @@ id: createAtom title: createAtom --- +# Function: createAtom() + ## Call Signature ```ts diff --git a/docs/reference/functions/createStore.md b/docs/reference/functions/createStore.md index 827f47e2..8c211275 100644 --- a/docs/reference/functions/createStore.md +++ b/docs/reference/functions/createStore.md @@ -3,6 +3,8 @@ id: createStore title: createStore --- +# Function: createStore() + ## Call Signature ```ts diff --git a/docs/reference/functions/flush.md b/docs/reference/functions/flush.md index 4e1ef6c9..37ab69a8 100644 --- a/docs/reference/functions/flush.md +++ b/docs/reference/functions/flush.md @@ -3,6 +3,8 @@ id: flush title: flush --- +# Function: flush() + ```ts function flush(): void; ``` diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md index e371f8c1..fb3b313a 100644 --- a/docs/reference/functions/shallow.md +++ b/docs/reference/functions/shallow.md @@ -3,6 +3,8 @@ id: shallow title: shallow --- +# Function: shallow() + ```ts function shallow(objA, objB): boolean; ``` diff --git a/docs/reference/functions/toObserver.md b/docs/reference/functions/toObserver.md index b303332c..67cf733b 100644 --- a/docs/reference/functions/toObserver.md +++ b/docs/reference/functions/toObserver.md @@ -3,6 +3,8 @@ id: toObserver title: toObserver --- +# Function: toObserver() + ```ts function toObserver( nextHandler?, diff --git a/docs/reference/index.md b/docs/reference/index.md index 9ef00a64..afc8e5dd 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,6 +3,8 @@ id: "@tanstack/store" title: "@tanstack/store" --- +# @tanstack/store + ## Classes - [ReadonlyStore](classes/ReadonlyStore.md) diff --git a/docs/reference/interfaces/Atom.md b/docs/reference/interfaces/Atom.md index 279539e7..63124fd2 100644 --- a/docs/reference/interfaces/Atom.md +++ b/docs/reference/interfaces/Atom.md @@ -3,6 +3,8 @@ id: Atom title: Atom --- +# Interface: Atom\ + Defined in: [types.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L42) ## Extends diff --git a/docs/reference/interfaces/AtomOptions.md b/docs/reference/interfaces/AtomOptions.md index 1d7e29cd..c05fee8d 100644 --- a/docs/reference/interfaces/AtomOptions.md +++ b/docs/reference/interfaces/AtomOptions.md @@ -3,6 +3,8 @@ id: AtomOptions title: AtomOptions --- +# Interface: AtomOptions\ + Defined in: [types.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L47) ## Type Parameters diff --git a/docs/reference/interfaces/BaseAtom.md b/docs/reference/interfaces/BaseAtom.md index 8a2a0c47..57de2ed9 100644 --- a/docs/reference/interfaces/BaseAtom.md +++ b/docs/reference/interfaces/BaseAtom.md @@ -3,6 +3,8 @@ id: BaseAtom title: BaseAtom --- +# Interface: BaseAtom\ + Defined in: [types.ts:33](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L33) ## Extends diff --git a/docs/reference/interfaces/InternalBaseAtom.md b/docs/reference/interfaces/InternalBaseAtom.md index 33fd0bd7..b2716e81 100644 --- a/docs/reference/interfaces/InternalBaseAtom.md +++ b/docs/reference/interfaces/InternalBaseAtom.md @@ -3,6 +3,8 @@ id: InternalBaseAtom title: InternalBaseAtom --- +# Interface: InternalBaseAtom\ + Defined in: [types.ts:35](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L35) ## Extends diff --git a/docs/reference/interfaces/InternalReadonlyAtom.md b/docs/reference/interfaces/InternalReadonlyAtom.md index 44632117..defd840e 100644 --- a/docs/reference/interfaces/InternalReadonlyAtom.md +++ b/docs/reference/interfaces/InternalReadonlyAtom.md @@ -3,6 +3,8 @@ id: InternalReadonlyAtom title: InternalReadonlyAtom --- +# Interface: InternalReadonlyAtom\ + Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53) ## Extends diff --git a/docs/reference/interfaces/InteropSubscribable.md b/docs/reference/interfaces/InteropSubscribable.md index f3dad5e5..45c4cea3 100644 --- a/docs/reference/interfaces/InteropSubscribable.md +++ b/docs/reference/interfaces/InteropSubscribable.md @@ -3,6 +3,8 @@ id: InteropSubscribable title: InteropSubscribable --- +# Interface: InteropSubscribable\ + Defined in: [types.ts:5](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L5) ## Extended by diff --git a/docs/reference/interfaces/Readable.md b/docs/reference/interfaces/Readable.md index e9e84490..96f344b1 100644 --- a/docs/reference/interfaces/Readable.md +++ b/docs/reference/interfaces/Readable.md @@ -3,6 +3,8 @@ id: Readable title: Readable --- +# Interface: Readable\ + Defined in: [types.ts:29](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L29) ## Extends diff --git a/docs/reference/interfaces/ReadonlyAtom.md b/docs/reference/interfaces/ReadonlyAtom.md index bc98e2de..2aeaa860 100644 --- a/docs/reference/interfaces/ReadonlyAtom.md +++ b/docs/reference/interfaces/ReadonlyAtom.md @@ -3,6 +3,8 @@ id: ReadonlyAtom title: ReadonlyAtom --- +# Interface: ReadonlyAtom\ + Defined in: [types.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L67) An atom that is read-only and cannot be set. diff --git a/docs/reference/interfaces/Subscribable.md b/docs/reference/interfaces/Subscribable.md index c15ec4b5..0857be0c 100644 --- a/docs/reference/interfaces/Subscribable.md +++ b/docs/reference/interfaces/Subscribable.md @@ -3,6 +3,8 @@ id: Subscribable title: Subscribable --- +# Interface: Subscribable\ + Defined in: [types.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L20) ## Extends diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index d258cd39..5ddc5fba 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -3,6 +3,8 @@ id: Subscription title: Subscription --- +# Interface: Subscription + Defined in: [types.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L16) ## Properties diff --git a/docs/reference/type-aliases/AnyAtom.md b/docs/reference/type-aliases/AnyAtom.md index eb2c7dbd..d41e125c 100644 --- a/docs/reference/type-aliases/AnyAtom.md +++ b/docs/reference/type-aliases/AnyAtom.md @@ -3,6 +3,8 @@ id: AnyAtom title: AnyAtom --- +# Type Alias: AnyAtom + ```ts type AnyAtom = BaseAtom; ``` diff --git a/docs/reference/type-aliases/Observer.md b/docs/reference/type-aliases/Observer.md index 65f901b7..47cd75dd 100644 --- a/docs/reference/type-aliases/Observer.md +++ b/docs/reference/type-aliases/Observer.md @@ -3,6 +3,8 @@ id: Observer title: Observer --- +# Type Alias: Observer\ + ```ts type Observer = object; ``` diff --git a/docs/reference/type-aliases/Selection.md b/docs/reference/type-aliases/Selection.md index 91b27b2a..484ad187 100644 --- a/docs/reference/type-aliases/Selection.md +++ b/docs/reference/type-aliases/Selection.md @@ -3,6 +3,8 @@ id: Selection title: Selection --- +# Type Alias: Selection\ + ```ts type Selection = Readable; ``` diff --git a/docs/reference/type-aliases/StoreAction.md b/docs/reference/type-aliases/StoreAction.md index 645ac1cd..1e839025 100644 --- a/docs/reference/type-aliases/StoreAction.md +++ b/docs/reference/type-aliases/StoreAction.md @@ -3,6 +3,8 @@ id: StoreAction title: StoreAction --- +# Type Alias: StoreAction() + ```ts type StoreAction = (...args) => any; ``` diff --git a/docs/reference/type-aliases/StoreActionMap.md b/docs/reference/type-aliases/StoreActionMap.md index fd5df617..5191c5f5 100644 --- a/docs/reference/type-aliases/StoreActionMap.md +++ b/docs/reference/type-aliases/StoreActionMap.md @@ -3,6 +3,8 @@ id: StoreActionMap title: StoreActionMap --- +# Type Alias: StoreActionMap + ```ts type StoreActionMap = Record; ``` diff --git a/docs/reference/type-aliases/StoreActionsFactory.md b/docs/reference/type-aliases/StoreActionsFactory.md index b22ccb91..b7caaee8 100644 --- a/docs/reference/type-aliases/StoreActionsFactory.md +++ b/docs/reference/type-aliases/StoreActionsFactory.md @@ -3,6 +3,8 @@ id: StoreActionsFactory title: StoreActionsFactory --- +# Type Alias: StoreActionsFactory()\ + ```ts type StoreActionsFactory = (store) => TActions; ``` From 4165d676bddfd00aa22bd45a349d0b4d407c4ac6 Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Thu, 10 Sep 2026 10:57:51 +0000 Subject: [PATCH 5/5] ci: apply automated fixes and generate docs --- .../framework/angular/reference/functions/createStoreContext.md | 2 -- docs/framework/angular/reference/functions/injectAtom.md | 2 -- docs/framework/angular/reference/functions/injectSelector.md | 2 -- docs/framework/angular/reference/functions/injectStore-1.md | 2 -- docs/framework/angular/reference/functions/injectStore.md | 2 -- docs/framework/angular/reference/index.md | 2 -- .../angular/reference/interfaces/InjectSelectorOptions.md | 2 -- .../angular/reference/interfaces/WritableAtomSignal.md | 2 -- .../framework/angular/reference/type-aliases/SelectionSource.md | 2 -- docs/framework/octane/reference/functions/createStoreContext.md | 2 -- docs/framework/octane/reference/functions/useAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateAtom.md | 2 -- docs/framework/octane/reference/functions/useCreateStore.md | 2 -- docs/framework/octane/reference/functions/useSelector.md | 2 -- docs/framework/octane/reference/index.md | 2 -- .../framework/octane/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/preact/reference/functions/createStoreContext.md | 2 -- docs/framework/preact/reference/functions/useAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateAtom.md | 2 -- docs/framework/preact/reference/functions/useCreateStore.md | 2 -- docs/framework/preact/reference/functions/useSelector.md | 2 -- docs/framework/preact/reference/functions/useStore-1.md | 2 -- docs/framework/preact/reference/functions/useStore.md | 2 -- docs/framework/preact/reference/index.md | 2 -- .../framework/preact/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/react/reference/functions/createStoreContext.md | 2 -- docs/framework/react/reference/functions/useAtom.md | 2 -- docs/framework/react/reference/functions/useCreateAtom.md | 2 -- docs/framework/react/reference/functions/useCreateStore.md | 2 -- docs/framework/react/reference/functions/useSelector.md | 2 -- docs/framework/react/reference/functions/useStore-1.md | 2 -- docs/framework/react/reference/functions/useStore.md | 2 -- docs/framework/react/reference/index.md | 2 -- docs/framework/react/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/solid/reference/functions/createStoreContext.md | 2 -- docs/framework/solid/reference/functions/useAtom.md | 2 -- docs/framework/solid/reference/functions/useSelector.md | 2 -- docs/framework/solid/reference/functions/useStore-1.md | 2 -- docs/framework/solid/reference/functions/useStore.md | 2 -- docs/framework/solid/reference/index.md | 2 -- docs/framework/solid/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/svelte/reference/functions/useAtom.md | 2 -- docs/framework/svelte/reference/functions/useSelector.md | 2 -- docs/framework/svelte/reference/functions/useStore-1.md | 2 -- docs/framework/svelte/reference/functions/useStore.md | 2 -- docs/framework/svelte/reference/index.md | 2 -- .../framework/svelte/reference/interfaces/UseSelectorOptions.md | 2 -- docs/framework/vue/reference/functions/useAtom.md | 2 -- docs/framework/vue/reference/functions/useSelector.md | 2 -- docs/framework/vue/reference/functions/useStore-1.md | 2 -- docs/framework/vue/reference/functions/useStore.md | 2 -- docs/framework/vue/reference/index.md | 2 -- docs/framework/vue/reference/interfaces/UseSelectorOptions.md | 2 -- docs/reference/classes/ReadonlyStore.md | 2 -- docs/reference/classes/Store.md | 2 -- docs/reference/functions/batch.md | 2 -- docs/reference/functions/createAsyncAtom.md | 2 -- docs/reference/functions/createAtom.md | 2 -- docs/reference/functions/createStore.md | 2 -- docs/reference/functions/flush.md | 2 -- docs/reference/functions/shallow.md | 2 -- docs/reference/functions/toObserver.md | 2 -- docs/reference/index.md | 2 -- docs/reference/interfaces/Atom.md | 2 -- docs/reference/interfaces/AtomOptions.md | 2 -- docs/reference/interfaces/BaseAtom.md | 2 -- docs/reference/interfaces/InternalBaseAtom.md | 2 -- docs/reference/interfaces/InternalReadonlyAtom.md | 2 -- docs/reference/interfaces/InteropSubscribable.md | 2 -- docs/reference/interfaces/Readable.md | 2 -- docs/reference/interfaces/ReadonlyAtom.md | 2 -- docs/reference/interfaces/Subscribable.md | 2 -- docs/reference/interfaces/Subscription.md | 2 -- docs/reference/type-aliases/AnyAtom.md | 2 -- docs/reference/type-aliases/Observer.md | 2 -- docs/reference/type-aliases/Selection.md | 2 -- docs/reference/type-aliases/StoreAction.md | 2 -- docs/reference/type-aliases/StoreActionMap.md | 2 -- docs/reference/type-aliases/StoreActionsFactory.md | 2 -- 79 files changed, 158 deletions(-) diff --git a/docs/framework/angular/reference/functions/createStoreContext.md b/docs/framework/angular/reference/functions/createStoreContext.md index 9d1a39a8..f79044fc 100644 --- a/docs/framework/angular/reference/functions/createStoreContext.md +++ b/docs/framework/angular/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/angular/reference/functions/injectAtom.md b/docs/framework/angular/reference/functions/injectAtom.md index 8d9bd6ef..e993c076 100644 --- a/docs/framework/angular/reference/functions/injectAtom.md +++ b/docs/framework/angular/reference/functions/injectAtom.md @@ -3,8 +3,6 @@ id: injectAtom title: injectAtom --- -# Function: injectAtom() - ```ts function injectAtom(atom, options?): WritableAtomSignal; ``` diff --git a/docs/framework/angular/reference/functions/injectSelector.md b/docs/framework/angular/reference/functions/injectSelector.md index a92e9bc2..baca3a87 100644 --- a/docs/framework/angular/reference/functions/injectSelector.md +++ b/docs/framework/angular/reference/functions/injectSelector.md @@ -3,8 +3,6 @@ id: injectSelector title: injectSelector --- -# Function: injectSelector() - ```ts function injectSelector( source, diff --git a/docs/framework/angular/reference/functions/injectStore-1.md b/docs/framework/angular/reference/functions/injectStore-1.md index 6e89cddc..8e693eb9 100644 --- a/docs/framework/angular/reference/functions/injectStore-1.md +++ b/docs/framework/angular/reference/functions/injectStore-1.md @@ -3,8 +3,6 @@ id: injectStore title: injectStore --- -# ~~Function: injectStore()~~ - ```ts function injectStore( store, diff --git a/docs/framework/angular/reference/functions/injectStore.md b/docs/framework/angular/reference/functions/injectStore.md index b88a398b..91347fb9 100644 --- a/docs/framework/angular/reference/functions/injectStore.md +++ b/docs/framework/angular/reference/functions/injectStore.md @@ -3,8 +3,6 @@ id: _injectStore title: _injectStore --- -# Function: \_injectStore() - ```ts function _injectStore( store, diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index 294379cc..7b5d6475 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/angular-store" title: "@tanstack/angular-store" --- -# @tanstack/angular-store - ## Interfaces - [InjectSelectorOptions](interfaces/InjectSelectorOptions.md) diff --git a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md index 993b6db4..b20bb642 100644 --- a/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md +++ b/docs/framework/angular/reference/interfaces/InjectSelectorOptions.md @@ -3,8 +3,6 @@ id: InjectSelectorOptions title: InjectSelectorOptions --- -# Interface: InjectSelectorOptions\ - Defined in: [packages/angular-store/src/injectSelector.ts:11](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectSelector.ts#L11) ## Extends diff --git a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md index ce3ea69a..b197a673 100644 --- a/docs/framework/angular/reference/interfaces/WritableAtomSignal.md +++ b/docs/framework/angular/reference/interfaces/WritableAtomSignal.md @@ -3,8 +3,6 @@ id: WritableAtomSignal title: WritableAtomSignal --- -# Interface: WritableAtomSignal()\ - Defined in: [packages/angular-store/src/injectAtom.ts:21](https://github.com/TanStack/store/blob/main/packages/angular-store/src/injectAtom.ts#L21) A callable signal that reads the current atom value when invoked and diff --git a/docs/framework/angular/reference/type-aliases/SelectionSource.md b/docs/framework/angular/reference/type-aliases/SelectionSource.md index 03444a60..3079d7cb 100644 --- a/docs/framework/angular/reference/type-aliases/SelectionSource.md +++ b/docs/framework/angular/reference/type-aliases/SelectionSource.md @@ -3,8 +3,6 @@ id: SelectionSource title: SelectionSource --- -# Type Alias: SelectionSource\ - ```ts type SelectionSource = object; ``` diff --git a/docs/framework/octane/reference/functions/createStoreContext.md b/docs/framework/octane/reference/functions/createStoreContext.md index b9b0e95f..fd81065b 100644 --- a/docs/framework/octane/reference/functions/createStoreContext.md +++ b/docs/framework/octane/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/octane/reference/functions/useAtom.md b/docs/framework/octane/reference/functions/useAtom.md index 289b16e2..a2813ae0 100644 --- a/docs/framework/octane/reference/functions/useAtom.md +++ b/docs/framework/octane/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom( atom, diff --git a/docs/framework/octane/reference/functions/useCreateAtom.md b/docs/framework/octane/reference/functions/useCreateAtom.md index bdc41bad..ba1f7050 100644 --- a/docs/framework/octane/reference/functions/useCreateAtom.md +++ b/docs/framework/octane/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Readonly atom ```ts diff --git a/docs/framework/octane/reference/functions/useCreateStore.md b/docs/framework/octane/reference/functions/useCreateStore.md index 63b25fe9..a83bb350 100644 --- a/docs/framework/octane/reference/functions/useCreateStore.md +++ b/docs/framework/octane/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Readonly store ```ts diff --git a/docs/framework/octane/reference/functions/useSelector.md b/docs/framework/octane/reference/functions/useSelector.md index a6093657..610792ff 100644 --- a/docs/framework/octane/reference/functions/useSelector.md +++ b/docs/framework/octane/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/octane/reference/index.md b/docs/framework/octane/reference/index.md index 7dbc161c..85438412 100644 --- a/docs/framework/octane/reference/index.md +++ b/docs/framework/octane/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/octane-store" title: "@tanstack/octane-store" --- -# @tanstack/octane-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md index 7f3d33a5..744df62b 100644 --- a/docs/framework/octane/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/octane/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [octane-store/src/useSelector.ts:5](https://github.com/TanStack/store/blob/main/packages/octane-store/src/useSelector.ts#L5) ## Type Parameters diff --git a/docs/framework/preact/reference/functions/createStoreContext.md b/docs/framework/preact/reference/functions/createStoreContext.md index bfc21a03..c7312462 100644 --- a/docs/framework/preact/reference/functions/createStoreContext.md +++ b/docs/framework/preact/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/preact/reference/functions/useAtom.md b/docs/framework/preact/reference/functions/useAtom.md index 9a0daab4..ca7b82ff 100644 --- a/docs/framework/preact/reference/functions/useAtom.md +++ b/docs/framework/preact/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/preact/reference/functions/useCreateAtom.md b/docs/framework/preact/reference/functions/useCreateAtom.md index a92253d0..5eae73c6 100644 --- a/docs/framework/preact/reference/functions/useCreateAtom.md +++ b/docs/framework/preact/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useCreateStore.md b/docs/framework/preact/reference/functions/useCreateStore.md index 56b8f91c..3345e513 100644 --- a/docs/framework/preact/reference/functions/useCreateStore.md +++ b/docs/framework/preact/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/preact/reference/functions/useSelector.md b/docs/framework/preact/reference/functions/useSelector.md index fe1036b3..9ecae133 100644 --- a/docs/framework/preact/reference/functions/useSelector.md +++ b/docs/framework/preact/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/preact/reference/functions/useStore-1.md b/docs/framework/preact/reference/functions/useStore-1.md index 9b45156b..1e0e5fa1 100644 --- a/docs/framework/preact/reference/functions/useStore-1.md +++ b/docs/framework/preact/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/preact/reference/functions/useStore.md b/docs/framework/preact/reference/functions/useStore.md index ecfcbe95..da7e2808 100644 --- a/docs/framework/preact/reference/functions/useStore.md +++ b/docs/framework/preact/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/preact/reference/index.md b/docs/framework/preact/reference/index.md index 76afd2bf..fc75d0df 100644 --- a/docs/framework/preact/reference/index.md +++ b/docs/framework/preact/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/preact-store" title: "@tanstack/preact-store" --- -# @tanstack/preact-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md index b3a6fa5e..432ad10c 100644 --- a/docs/framework/preact/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/preact/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [preact-store/src/useSelector.ts:9](https://github.com/TanStack/store/blob/main/packages/preact-store/src/useSelector.ts#L9) ## Type Parameters diff --git a/docs/framework/react/reference/functions/createStoreContext.md b/docs/framework/react/reference/functions/createStoreContext.md index c7bfe786..9c81832c 100644 --- a/docs/framework/react/reference/functions/createStoreContext.md +++ b/docs/framework/react/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/react/reference/functions/useAtom.md b/docs/framework/react/reference/functions/useAtom.md index 5cd2eb68..bee705db 100644 --- a/docs/framework/react/reference/functions/useAtom.md +++ b/docs/framework/react/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [TValue, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/react/reference/functions/useCreateAtom.md b/docs/framework/react/reference/functions/useCreateAtom.md index 1b6cfaab..eb5db9fa 100644 --- a/docs/framework/react/reference/functions/useCreateAtom.md +++ b/docs/framework/react/reference/functions/useCreateAtom.md @@ -3,8 +3,6 @@ id: useCreateAtom title: useCreateAtom --- -# Function: useCreateAtom() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useCreateStore.md b/docs/framework/react/reference/functions/useCreateStore.md index f01d05ba..07acc257 100644 --- a/docs/framework/react/reference/functions/useCreateStore.md +++ b/docs/framework/react/reference/functions/useCreateStore.md @@ -3,8 +3,6 @@ id: useCreateStore title: useCreateStore --- -# Function: useCreateStore() - ## Call Signature ```ts diff --git a/docs/framework/react/reference/functions/useSelector.md b/docs/framework/react/reference/functions/useSelector.md index 4eb73ea7..e4035fbd 100644 --- a/docs/framework/react/reference/functions/useSelector.md +++ b/docs/framework/react/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/react/reference/functions/useStore-1.md b/docs/framework/react/reference/functions/useStore-1.md index 76506468..cfc238f7 100644 --- a/docs/framework/react/reference/functions/useStore-1.md +++ b/docs/framework/react/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/react/reference/functions/useStore.md b/docs/framework/react/reference/functions/useStore.md index bbc43c6b..3ca150f3 100644 --- a/docs/framework/react/reference/functions/useStore.md +++ b/docs/framework/react/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/react/reference/index.md b/docs/framework/react/reference/index.md index 957bf4c4..4900ddfe 100644 --- a/docs/framework/react/reference/index.md +++ b/docs/framework/react/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/react-store" title: "@tanstack/react-store" --- -# @tanstack/react-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/react/reference/interfaces/UseSelectorOptions.md b/docs/framework/react/reference/interfaces/UseSelectorOptions.md index efaa91df..551e84f7 100644 --- a/docs/framework/react/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/react/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [packages/react-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/react-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/solid/reference/functions/createStoreContext.md b/docs/framework/solid/reference/functions/createStoreContext.md index 2ff36e6d..41ddddfe 100644 --- a/docs/framework/solid/reference/functions/createStoreContext.md +++ b/docs/framework/solid/reference/functions/createStoreContext.md @@ -3,8 +3,6 @@ id: createStoreContext title: createStoreContext --- -# Function: createStoreContext() - ```ts function createStoreContext(): object; ``` diff --git a/docs/framework/solid/reference/functions/useAtom.md b/docs/framework/solid/reference/functions/useAtom.md index a05c4337..e40a43e9 100644 --- a/docs/framework/solid/reference/functions/useAtom.md +++ b/docs/framework/solid/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Accessor, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/solid/reference/functions/useSelector.md b/docs/framework/solid/reference/functions/useSelector.md index ed6f3961..4a674915 100644 --- a/docs/framework/solid/reference/functions/useSelector.md +++ b/docs/framework/solid/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/solid/reference/functions/useStore-1.md b/docs/framework/solid/reference/functions/useStore-1.md index e51f0ccb..4f3abc94 100644 --- a/docs/framework/solid/reference/functions/useStore-1.md +++ b/docs/framework/solid/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/solid/reference/functions/useStore.md b/docs/framework/solid/reference/functions/useStore.md index 046e7a04..b1ffe800 100644 --- a/docs/framework/solid/reference/functions/useStore.md +++ b/docs/framework/solid/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/solid/reference/index.md b/docs/framework/solid/reference/index.md index bfe6ce88..45eda670 100644 --- a/docs/framework/solid/reference/index.md +++ b/docs/framework/solid/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/solid-store" title: "@tanstack/solid-store" --- -# @tanstack/solid-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md index 2d3845b8..82da6866 100644 --- a/docs/framework/solid/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/solid/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [solid-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/solid-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/framework/svelte/reference/functions/useAtom.md b/docs/framework/svelte/reference/functions/useAtom.md index 727d42bb..6e16b4d2 100644 --- a/docs/framework/svelte/reference/functions/useAtom.md +++ b/docs/framework/svelte/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [{ current: TValue; diff --git a/docs/framework/svelte/reference/functions/useSelector.md b/docs/framework/svelte/reference/functions/useSelector.md index a0abbb21..6e65346e 100644 --- a/docs/framework/svelte/reference/functions/useSelector.md +++ b/docs/framework/svelte/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/svelte/reference/functions/useStore-1.md b/docs/framework/svelte/reference/functions/useStore-1.md index b3d49758..50133785 100644 --- a/docs/framework/svelte/reference/functions/useStore-1.md +++ b/docs/framework/svelte/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/svelte/reference/functions/useStore.md b/docs/framework/svelte/reference/functions/useStore.md index 8de580f1..5499b29c 100644 --- a/docs/framework/svelte/reference/functions/useStore.md +++ b/docs/framework/svelte/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 531a5c99..39f4071a 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/svelte-store" title: "@tanstack/svelte-store" --- -# @tanstack/svelte-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md index 6dfeceff..a1287ba6 100644 --- a/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/svelte/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [svelte-store/src/useSelector.svelte.ts:3](https://github.com/TanStack/store/blob/main/packages/svelte-store/src/useSelector.svelte.ts#L3) ## Type Parameters diff --git a/docs/framework/vue/reference/functions/useAtom.md b/docs/framework/vue/reference/functions/useAtom.md index 6b598d89..1ba41a97 100644 --- a/docs/framework/vue/reference/functions/useAtom.md +++ b/docs/framework/vue/reference/functions/useAtom.md @@ -3,8 +3,6 @@ id: useAtom title: useAtom --- -# Function: useAtom() - ```ts function useAtom(atom, options?): [Readonly>, (fn) => void & (value) => void]; ``` diff --git a/docs/framework/vue/reference/functions/useSelector.md b/docs/framework/vue/reference/functions/useSelector.md index adc70581..eb1fc8e2 100644 --- a/docs/framework/vue/reference/functions/useSelector.md +++ b/docs/framework/vue/reference/functions/useSelector.md @@ -3,8 +3,6 @@ id: useSelector title: useSelector --- -# Function: useSelector() - ```ts function useSelector( source, diff --git a/docs/framework/vue/reference/functions/useStore-1.md b/docs/framework/vue/reference/functions/useStore-1.md index a96bb61e..f7f6be01 100644 --- a/docs/framework/vue/reference/functions/useStore-1.md +++ b/docs/framework/vue/reference/functions/useStore-1.md @@ -3,8 +3,6 @@ id: useStore title: useStore --- -# ~~Function: useStore()~~ - ```ts function useStore( source, diff --git a/docs/framework/vue/reference/functions/useStore.md b/docs/framework/vue/reference/functions/useStore.md index 0a14ea38..98f104ac 100644 --- a/docs/framework/vue/reference/functions/useStore.md +++ b/docs/framework/vue/reference/functions/useStore.md @@ -3,8 +3,6 @@ id: _useStore title: _useStore --- -# Function: \_useStore() - ```ts function _useStore( store, diff --git a/docs/framework/vue/reference/index.md b/docs/framework/vue/reference/index.md index cc4e9333..6f5d5f42 100644 --- a/docs/framework/vue/reference/index.md +++ b/docs/framework/vue/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/vue-store" title: "@tanstack/vue-store" --- -# @tanstack/vue-store - ## Interfaces - [UseSelectorOptions](interfaces/UseSelectorOptions.md) diff --git a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md index dc0616ce..2838e456 100644 --- a/docs/framework/vue/reference/interfaces/UseSelectorOptions.md +++ b/docs/framework/vue/reference/interfaces/UseSelectorOptions.md @@ -3,8 +3,6 @@ id: UseSelectorOptions title: UseSelectorOptions --- -# Interface: UseSelectorOptions\ - Defined in: [vue-store/src/useSelector.ts:4](https://github.com/TanStack/store/blob/main/packages/vue-store/src/useSelector.ts#L4) ## Type Parameters diff --git a/docs/reference/classes/ReadonlyStore.md b/docs/reference/classes/ReadonlyStore.md index e23ee15c..97dd2e88 100644 --- a/docs/reference/classes/ReadonlyStore.md +++ b/docs/reference/classes/ReadonlyStore.md @@ -3,8 +3,6 @@ id: ReadonlyStore title: ReadonlyStore --- -# Class: ReadonlyStore\ - Defined in: [store.ts:59](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L59) ## Type Parameters diff --git a/docs/reference/classes/Store.md b/docs/reference/classes/Store.md index 346926a3..7d0eab2c 100644 --- a/docs/reference/classes/Store.md +++ b/docs/reference/classes/Store.md @@ -3,8 +3,6 @@ id: Store title: Store --- -# Class: Store\ - Defined in: [store.ts:15](https://github.com/TanStack/store/blob/main/packages/store/src/store.ts#L15) ## Type Parameters diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index f3de25ce..43c3f38e 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -3,8 +3,6 @@ id: batch title: batch --- -# Function: batch() - ```ts function batch(fn): void; ``` diff --git a/docs/reference/functions/createAsyncAtom.md b/docs/reference/functions/createAsyncAtom.md index 828bfce8..4bf0c602 100644 --- a/docs/reference/functions/createAsyncAtom.md +++ b/docs/reference/functions/createAsyncAtom.md @@ -3,8 +3,6 @@ id: createAsyncAtom title: createAsyncAtom --- -# Function: createAsyncAtom() - ```ts function createAsyncAtom(getValue, options?): ReadonlyAtom>; ``` diff --git a/docs/reference/functions/createAtom.md b/docs/reference/functions/createAtom.md index 79dce560..eed96287 100644 --- a/docs/reference/functions/createAtom.md +++ b/docs/reference/functions/createAtom.md @@ -3,8 +3,6 @@ id: createAtom title: createAtom --- -# Function: createAtom() - ## Call Signature ```ts diff --git a/docs/reference/functions/createStore.md b/docs/reference/functions/createStore.md index 8c211275..827f47e2 100644 --- a/docs/reference/functions/createStore.md +++ b/docs/reference/functions/createStore.md @@ -3,8 +3,6 @@ id: createStore title: createStore --- -# Function: createStore() - ## Call Signature ```ts diff --git a/docs/reference/functions/flush.md b/docs/reference/functions/flush.md index 37ab69a8..4e1ef6c9 100644 --- a/docs/reference/functions/flush.md +++ b/docs/reference/functions/flush.md @@ -3,8 +3,6 @@ id: flush title: flush --- -# Function: flush() - ```ts function flush(): void; ``` diff --git a/docs/reference/functions/shallow.md b/docs/reference/functions/shallow.md index fb3b313a..e371f8c1 100644 --- a/docs/reference/functions/shallow.md +++ b/docs/reference/functions/shallow.md @@ -3,8 +3,6 @@ id: shallow title: shallow --- -# Function: shallow() - ```ts function shallow(objA, objB): boolean; ``` diff --git a/docs/reference/functions/toObserver.md b/docs/reference/functions/toObserver.md index 67cf733b..b303332c 100644 --- a/docs/reference/functions/toObserver.md +++ b/docs/reference/functions/toObserver.md @@ -3,8 +3,6 @@ id: toObserver title: toObserver --- -# Function: toObserver() - ```ts function toObserver( nextHandler?, diff --git a/docs/reference/index.md b/docs/reference/index.md index afc8e5dd..9ef00a64 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -3,8 +3,6 @@ id: "@tanstack/store" title: "@tanstack/store" --- -# @tanstack/store - ## Classes - [ReadonlyStore](classes/ReadonlyStore.md) diff --git a/docs/reference/interfaces/Atom.md b/docs/reference/interfaces/Atom.md index 63124fd2..279539e7 100644 --- a/docs/reference/interfaces/Atom.md +++ b/docs/reference/interfaces/Atom.md @@ -3,8 +3,6 @@ id: Atom title: Atom --- -# Interface: Atom\ - Defined in: [types.ts:42](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L42) ## Extends diff --git a/docs/reference/interfaces/AtomOptions.md b/docs/reference/interfaces/AtomOptions.md index c05fee8d..1d7e29cd 100644 --- a/docs/reference/interfaces/AtomOptions.md +++ b/docs/reference/interfaces/AtomOptions.md @@ -3,8 +3,6 @@ id: AtomOptions title: AtomOptions --- -# Interface: AtomOptions\ - Defined in: [types.ts:47](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L47) ## Type Parameters diff --git a/docs/reference/interfaces/BaseAtom.md b/docs/reference/interfaces/BaseAtom.md index 57de2ed9..8a2a0c47 100644 --- a/docs/reference/interfaces/BaseAtom.md +++ b/docs/reference/interfaces/BaseAtom.md @@ -3,8 +3,6 @@ id: BaseAtom title: BaseAtom --- -# Interface: BaseAtom\ - Defined in: [types.ts:33](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L33) ## Extends diff --git a/docs/reference/interfaces/InternalBaseAtom.md b/docs/reference/interfaces/InternalBaseAtom.md index b2716e81..33fd0bd7 100644 --- a/docs/reference/interfaces/InternalBaseAtom.md +++ b/docs/reference/interfaces/InternalBaseAtom.md @@ -3,8 +3,6 @@ id: InternalBaseAtom title: InternalBaseAtom --- -# Interface: InternalBaseAtom\ - Defined in: [types.ts:35](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L35) ## Extends diff --git a/docs/reference/interfaces/InternalReadonlyAtom.md b/docs/reference/interfaces/InternalReadonlyAtom.md index defd840e..44632117 100644 --- a/docs/reference/interfaces/InternalReadonlyAtom.md +++ b/docs/reference/interfaces/InternalReadonlyAtom.md @@ -3,8 +3,6 @@ id: InternalReadonlyAtom title: InternalReadonlyAtom --- -# Interface: InternalReadonlyAtom\ - Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53) ## Extends diff --git a/docs/reference/interfaces/InteropSubscribable.md b/docs/reference/interfaces/InteropSubscribable.md index 45c4cea3..f3dad5e5 100644 --- a/docs/reference/interfaces/InteropSubscribable.md +++ b/docs/reference/interfaces/InteropSubscribable.md @@ -3,8 +3,6 @@ id: InteropSubscribable title: InteropSubscribable --- -# Interface: InteropSubscribable\ - Defined in: [types.ts:5](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L5) ## Extended by diff --git a/docs/reference/interfaces/Readable.md b/docs/reference/interfaces/Readable.md index 96f344b1..e9e84490 100644 --- a/docs/reference/interfaces/Readable.md +++ b/docs/reference/interfaces/Readable.md @@ -3,8 +3,6 @@ id: Readable title: Readable --- -# Interface: Readable\ - Defined in: [types.ts:29](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L29) ## Extends diff --git a/docs/reference/interfaces/ReadonlyAtom.md b/docs/reference/interfaces/ReadonlyAtom.md index 2aeaa860..bc98e2de 100644 --- a/docs/reference/interfaces/ReadonlyAtom.md +++ b/docs/reference/interfaces/ReadonlyAtom.md @@ -3,8 +3,6 @@ id: ReadonlyAtom title: ReadonlyAtom --- -# Interface: ReadonlyAtom\ - Defined in: [types.ts:67](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L67) An atom that is read-only and cannot be set. diff --git a/docs/reference/interfaces/Subscribable.md b/docs/reference/interfaces/Subscribable.md index 0857be0c..c15ec4b5 100644 --- a/docs/reference/interfaces/Subscribable.md +++ b/docs/reference/interfaces/Subscribable.md @@ -3,8 +3,6 @@ id: Subscribable title: Subscribable --- -# Interface: Subscribable\ - Defined in: [types.ts:20](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L20) ## Extends diff --git a/docs/reference/interfaces/Subscription.md b/docs/reference/interfaces/Subscription.md index 5ddc5fba..d258cd39 100644 --- a/docs/reference/interfaces/Subscription.md +++ b/docs/reference/interfaces/Subscription.md @@ -3,8 +3,6 @@ id: Subscription title: Subscription --- -# Interface: Subscription - Defined in: [types.ts:16](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L16) ## Properties diff --git a/docs/reference/type-aliases/AnyAtom.md b/docs/reference/type-aliases/AnyAtom.md index d41e125c..eb2c7dbd 100644 --- a/docs/reference/type-aliases/AnyAtom.md +++ b/docs/reference/type-aliases/AnyAtom.md @@ -3,8 +3,6 @@ id: AnyAtom title: AnyAtom --- -# Type Alias: AnyAtom - ```ts type AnyAtom = BaseAtom; ``` diff --git a/docs/reference/type-aliases/Observer.md b/docs/reference/type-aliases/Observer.md index 47cd75dd..65f901b7 100644 --- a/docs/reference/type-aliases/Observer.md +++ b/docs/reference/type-aliases/Observer.md @@ -3,8 +3,6 @@ id: Observer title: Observer --- -# Type Alias: Observer\ - ```ts type Observer = object; ``` diff --git a/docs/reference/type-aliases/Selection.md b/docs/reference/type-aliases/Selection.md index 484ad187..91b27b2a 100644 --- a/docs/reference/type-aliases/Selection.md +++ b/docs/reference/type-aliases/Selection.md @@ -3,8 +3,6 @@ id: Selection title: Selection --- -# Type Alias: Selection\ - ```ts type Selection = Readable; ``` diff --git a/docs/reference/type-aliases/StoreAction.md b/docs/reference/type-aliases/StoreAction.md index 1e839025..645ac1cd 100644 --- a/docs/reference/type-aliases/StoreAction.md +++ b/docs/reference/type-aliases/StoreAction.md @@ -3,8 +3,6 @@ id: StoreAction title: StoreAction --- -# Type Alias: StoreAction() - ```ts type StoreAction = (...args) => any; ``` diff --git a/docs/reference/type-aliases/StoreActionMap.md b/docs/reference/type-aliases/StoreActionMap.md index 5191c5f5..fd5df617 100644 --- a/docs/reference/type-aliases/StoreActionMap.md +++ b/docs/reference/type-aliases/StoreActionMap.md @@ -3,8 +3,6 @@ id: StoreActionMap title: StoreActionMap --- -# Type Alias: StoreActionMap - ```ts type StoreActionMap = Record; ``` diff --git a/docs/reference/type-aliases/StoreActionsFactory.md b/docs/reference/type-aliases/StoreActionsFactory.md index b7caaee8..b22ccb91 100644 --- a/docs/reference/type-aliases/StoreActionsFactory.md +++ b/docs/reference/type-aliases/StoreActionsFactory.md @@ -3,8 +3,6 @@ id: StoreActionsFactory title: StoreActionsFactory --- -# Type Alias: StoreActionsFactory()\ - ```ts type StoreActionsFactory = (store) => TActions; ```