themeConfig: {
logo: '/logo.svg',
+ outline: [2, 3],
socialLinks: [
{ icon: 'twitter', link: 'https://twitter.com/posva' },
themeConfig: {
editLink: {
- // TODO: do we need the /zh/
pattern: 'https://github.com/vuejs/pinia/edit/v2/packages/docs/:path',
text: '对本页提出修改建议',
},
+ outlineTitle: '本页内容',
+
nav: [
// { text: 'Config', link: '/config/' },
// { text: 'Plugins', link: '/plugins/' },
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / MutationType
-# Enumeration: MutationType %{#Enumeration:-MutationType}%
+# Enumeration: MutationType
[pinia](../modules/pinia.md).MutationType
Possible types for SubscriptionCallback
-## Enumeration Members %{#Enumeration:-MutationType-Enumeration-Members}%
+## Enumeration Members %{#Enumeration-Members}%
-### direct %{#Enumeration:-MutationType-Enumeration-Members-direct}%
+### direct %{#Enumeration-Members-direct}%
• **direct** = ``"direct"``
___
-### patchFunction %{#Enumeration:-MutationType-Enumeration-Members-patchFunction}%
+### patchFunction %{#Enumeration-Members-patchFunction}%
• **patchFunction** = ``"patch function"``
___
-### patchObject %{#Enumeration:-MutationType-Enumeration-Members-patchObject}%
+### patchObject %{#Enumeration-Members-patchObject}%
• **patchObject** = ``"patch object"``
API Documentation
-# API Documentation %{#API-Documentation}%
+# API Documentation
-## Modules %{#API-Documentation-Modules}%
+## Modules %{#Modules}%
- [@pinia/nuxt](modules/pinia_nuxt.md)
- [@pinia/testing](modules/pinia_testing.md)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineSetupStoreOptions
-# Interface: DefineSetupStoreOptions<Id, S, G, A\> %{#Interface:-DefineSetupStoreOptions<Id,-S,-G,-A\>}%
+# Interface: DefineSetupStoreOptions<Id, S, G, A\>
[pinia](../modules/pinia.md).DefineSetupStoreOptions
[DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md).
-## Type parameters %{#Interface:-DefineSetupStoreOptions<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | `G` |
| `A` | `A` |
-## Hierarchy %{#Interface:-DefineSetupStoreOptions<Id,-S,-G,-A\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\>
↳ **`DefineSetupStoreOptions`**
-## Properties %{#Interface:-DefineSetupStoreOptions<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### actions %{#Interface:-DefineSetupStoreOptions<Id,-S,-G,-A\>-Properties-actions}%
+### actions %{#Properties-actions}%
• `Optional` **actions**: `A`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptions
-# Interface: DefineStoreOptions<Id, S, G, A\> %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>}%
+# Interface: DefineStoreOptions<Id, S, G, A\>
[pinia](../modules/pinia.md).DefineStoreOptions
[DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md).
-## Type parameters %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | `G` |
| `A` | `A` |
-## Hierarchy %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\>
↳ **`DefineStoreOptions`**
-## Properties %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### actions %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-actions}%
+### actions %{#Properties-actions}%
• `Optional` **actions**: `A` & `ThisType`<`A` & `UnwrapRef`<`S`\> & [`_StoreWithState`](pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\>
___
-### getters %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-getters}%
+### getters %{#Properties-getters}%
• `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\> & [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\>
___
-### id %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-id}%
+### id %{#Properties-id}%
• **id**: `Id`
___
-### state %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-state}%
+### state %{#Properties-state}%
• `Optional` **state**: () => `S`
-#### Type declaration %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-state-Type-declaration}%
+#### Type declaration %{#Properties-state-Type-declaration}%
▸ (): `S`
Function to create a fresh state. **Must be an arrow function** to ensure
correct typings!
-##### Returns %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Properties-state-Type-declaration-Returns}%
+##### Returns %{#Properties-state-Type-declaration-Returns}%
`S`
-## Methods %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Methods}%
+## Methods %{#Methods}%
-### hydrate %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Methods-hydrate}%
+### hydrate %{#Methods-hydrate}%
▸ `Optional` **hydrate**(`storeState`, `initialState`): `void`
})
```
-#### Parameters %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Methods-hydrate-Parameters}%
+#### Parameters %{#Methods-hydrate-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `storeState` | `UnwrapRef`<`S`\> | the current state in the store |
| `initialState` | `UnwrapRef`<`S`\> | initialState |
-#### Returns %{#Interface:-DefineStoreOptions<Id,-S,-G,-A\>-Methods-hydrate-Returns}%
+#### Returns %{#Methods-hydrate-Returns}%
`void`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsBase
-# Interface: DefineStoreOptionsBase<S, Store\> %{#Interface:-DefineStoreOptionsBase<S,-Store\>}%
+# Interface: DefineStoreOptionsBase<S, Store\>
[pinia](../modules/pinia.md).DefineStoreOptionsBase
stores. Extend this interface if you want to add custom options to both kinds
of stores.
-## Type parameters %{#Interface:-DefineStoreOptionsBase<S,-Store\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `S` | extends [`StateTree`](../modules/pinia.md#statetree) |
| `Store` | `Store` |
-## Hierarchy %{#Interface:-DefineStoreOptionsBase<S,-Store\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- **`DefineStoreOptionsBase`**
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsInPlugin
-# Interface: DefineStoreOptionsInPlugin<Id, S, G, A\> %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>}%
+# Interface: DefineStoreOptionsInPlugin<Id, S, G, A\>
[pinia](../modules/pinia.md).DefineStoreOptionsInPlugin
Available `options` when creating a pinia plugin.
-## Type parameters %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | `G` |
| `A` | `A` |
-## Hierarchy %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- `Omit`<[`DefineStoreOptions`](pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\>, ``"id"`` \| ``"actions"``\>
↳ **`DefineStoreOptionsInPlugin`**
-## Properties %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### actions %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-actions}%
+### actions %{#Properties-actions}%
• **actions**: `A`
___
-### getters %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-getters}%
+### getters %{#Properties-getters}%
• `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\> & [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\>
Optional object of getters.
-#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-getters-Inherited-from}%
+#### Inherited from %{#Properties-getters-Inherited-from}%
Omit.getters
___
-### state %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-state}%
+### state %{#Properties-state}%
• `Optional` **state**: () => `S`
-#### Type declaration %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-state-Type-declaration}%
+#### Type declaration %{#Properties-state-Type-declaration}%
▸ (): `S`
Function to create a fresh state. **Must be an arrow function** to ensure
correct typings!
-##### Returns %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-state-Type-declaration-Returns}%
+##### Returns %{#Properties-state-Type-declaration-Returns}%
`S`
-#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Properties-state-Inherited-from}%
+#### Inherited from %{#Properties-state-Inherited-from}%
Omit.state
-## Methods %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Methods}%
+## Methods %{#Methods}%
-### hydrate %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Methods-hydrate}%
+### hydrate %{#Methods-hydrate}%
▸ `Optional` **hydrate**(`storeState`, `initialState`): `void`
})
```
-#### Parameters %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Methods-hydrate-Parameters}%
+#### Parameters %{#Methods-hydrate-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `storeState` | `UnwrapRef`<`S`\> | the current state in the store |
| `initialState` | `UnwrapRef`<`S`\> | initialState |
-#### Returns %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Methods-hydrate-Returns}%
+#### Returns %{#Methods-hydrate-Returns}%
`void`
-#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin<Id,-S,-G,-A\>-Methods-hydrate-Inherited-from}%
+#### Inherited from %{#Methods-hydrate-Inherited-from}%
Omit.hydrate
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / MapStoresCustomization
-# Interface: MapStoresCustomization %{#Interface:-MapStoresCustomization}%
+# Interface: MapStoresCustomization
[pinia](../modules/pinia.md).MapStoresCustomization
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / Pinia
-# Interface: Pinia %{#Interface:-Pinia}%
+# Interface: Pinia
[pinia](../modules/pinia.md).Pinia
Every application must own its own pinia to be able to create stores
-## Hierarchy %{#Interface:-Pinia-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- **`Pinia`**
↳ [`TestingPinia`](pinia_testing.TestingPinia.md)
-## Properties %{#Interface:-Pinia-Properties}%
+## Properties %{#Properties}%
-### install %{#Interface:-Pinia-Properties-install}%
+### install %{#Properties-install}%
• **install**: (`app`: `App`<`any`\>) => `void`
-#### Type declaration %{#Interface:-Pinia-Properties-install-Type-declaration}%
+#### Type declaration %{#Properties-install-Type-declaration}%
▸ (`app`): `void`
-##### Parameters %{#Interface:-Pinia-Properties-install-Type-declaration-Parameters}%
+##### Parameters %{#Properties-install-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `app` | `App`<`any`\> |
-##### Returns %{#Interface:-Pinia-Properties-install-Type-declaration-Returns}%
+##### Returns %{#Properties-install-Type-declaration-Returns}%
`void`
___
-### state %{#Interface:-Pinia-Properties-state}%
+### state %{#Properties-state}%
• **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\>
root state
-## Methods %{#Interface:-Pinia-Methods}%
+## Methods %{#Methods}%
-### use %{#Interface:-Pinia-Methods-use}%
+### use %{#Methods-use}%
▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md)
Adds a store plugin to extend every store
-#### Parameters %{#Interface:-Pinia-Methods-use-Parameters}%
+#### Parameters %{#Methods-use-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add |
-#### Returns %{#Interface:-Pinia-Methods-use-Returns}%
+#### Returns %{#Methods-use-Returns}%
[`Pinia`](pinia.Pinia.md)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomProperties
-# Interface: PiniaCustomProperties<Id, S, G, A\> %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>}%
+# Interface: PiniaCustomProperties<Id, S, G, A\>
[pinia](../modules/pinia.md).PiniaCustomProperties
Interface to be extended by the user when they add properties through plugins.
-## Type parameters %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> |
| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) |
-## Accessors %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Accessors}%
+## Accessors %{#Accessors}%
-### route %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Accessors-route}%
+### route %{#Accessors-route}%
• `get` **route**(): `RouteLocationNormalized`
-#### Returns %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Accessors-route-Returns}%
+#### Returns %{#Accessors-route-Returns}%
`RouteLocationNormalized`
• `set` **route**(`value`): `void`
-#### Parameters %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Accessors-route-Parameters}%
+#### Parameters %{#Accessors-route-Parameters}%
| Name | Type |
| :------ | :------ |
| `value` | `RouteLocationNormalizedLoaded` \| `Ref`<`RouteLocationNormalizedLoaded`\> |
-#### Returns %{#Interface:-PiniaCustomProperties<Id,-S,-G,-A\>-Accessors-route-Returns_1}%
+#### Returns %{#Accessors-route-Returns_1}%
`void`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomStateProperties
-# Interface: PiniaCustomStateProperties<S\> %{#Interface:-PiniaCustomStateProperties<S\>}%
+# Interface: PiniaCustomStateProperties<S\>
[pinia](../modules/pinia.md).PiniaCustomStateProperties
Properties that are added to every `store.$state` by `pinia.use()`.
-## Type parameters %{#Interface:-PiniaCustomStateProperties<S\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPlugin
-# Interface: PiniaPlugin %{#Interface:-PiniaPlugin}%
+# Interface: PiniaPlugin
[pinia](../modules/pinia.md).PiniaPlugin
-## Callable %{#Interface:-PiniaPlugin-Callable}%
+## Callable %{#Callable}%
-### PiniaPlugin %{#Interface:-PiniaPlugin-Callable-PiniaPlugin}%
+### PiniaPlugin %{#Callable-PiniaPlugin}%
▸ **PiniaPlugin**(`context`): `void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<[`StateTree`](../modules/pinia.md#statetree)\>\>
Plugin to extend every store. Returns an object to extend the store or
nothing.
-#### Parameters %{#Interface:-PiniaPlugin-Callable-PiniaPlugin-Parameters}%
+#### Parameters %{#Callable-PiniaPlugin-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `context` | [`PiniaPluginContext`](pinia.PiniaPluginContext.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> | Context |
-#### Returns %{#Interface:-PiniaPlugin-Callable-PiniaPlugin-Returns}%
+#### Returns %{#Callable-PiniaPlugin-Returns}%
`void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<[`StateTree`](../modules/pinia.md#statetree)\>\>
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPluginContext
-# Interface: PiniaPluginContext<Id, S, G, A\> %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>}%
+# Interface: PiniaPluginContext<Id, S, G, A\>
[pinia](../modules/pinia.md).PiniaPluginContext
Context argument passed to Pinia plugins.
-## Type parameters %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> |
| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) |
-## Properties %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### app %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Properties-app}%
+### app %{#Properties-app}%
• **app**: `App`<`any`\>
___
-### options %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Properties-options}%
+### options %{#Properties-options}%
• **options**: [`DefineStoreOptionsInPlugin`](pinia.DefineStoreOptionsInPlugin.md)<`Id`, `S`, `G`, `A`\>
___
-### pinia %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Properties-pinia}%
+### pinia %{#Properties-pinia}%
• **pinia**: [`Pinia`](pinia.Pinia.md)
___
-### store %{#Interface:-PiniaPluginContext<Id,-S,-G,-A\>-Properties-store}%
+### store %{#Properties-store}%
• **store**: [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreDefinition
-# Interface: StoreDefinition<Id, S, G, A\> %{#Interface:-StoreDefinition<Id,-S,-G,-A\>}%
+# Interface: StoreDefinition<Id, S, G, A\>
[pinia](../modules/pinia.md).StoreDefinition
-## Type parameters %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> |
| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) |
-## Callable %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Callable}%
+## Callable %{#Callable}%
-### StoreDefinition %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Callable-StoreDefinition}%
+### StoreDefinition %{#Callable-StoreDefinition}%
▸ **StoreDefinition**(`pinia?`, `hot?`): [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>
Returns a store, creates it if necessary.
-#### Parameters %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Callable-StoreDefinition-Parameters}%
+#### Parameters %{#Callable-StoreDefinition-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `pinia?` | ``null`` \| [`Pinia`](pinia.Pinia.md) | Pinia instance to retrieve the store |
| `hot?` | [`StoreGeneric`](../modules/pinia.md#storegeneric) | dev only hot module replacement |
-#### Returns %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Callable-StoreDefinition-Returns}%
+#### Returns %{#Callable-StoreDefinition-Returns}%
[`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>
-## Properties %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### $id %{#Interface:-StoreDefinition<Id,-S,-G,-A\>-Properties-$id}%
+### $id %{#Properties-$id}%
• **$id**: `Id`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreProperties
-# Interface: StoreProperties<Id\> %{#Interface:-StoreProperties<Id\>}%
+# Interface: StoreProperties<Id\>
[pinia](../modules/pinia.md).StoreProperties
Properties of a store.
-## Type parameters %{#Interface:-StoreProperties<Id\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `Id` | extends `string` |
-## Hierarchy %{#Interface:-StoreProperties<Id\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- **`StoreProperties`**
↳ [`_StoreWithState`](pinia._StoreWithState.md)
-## Properties %{#Interface:-StoreProperties<Id\>-Properties}%
+## Properties %{#Properties}%
-### $id %{#Interface:-StoreProperties<Id\>-Properties-$id}%
+### $id %{#Properties-$id}%
• **$id**: `Id`
___
-### \_customProperties %{#Interface:-StoreProperties<Id\>-Properties-\_customProperties}%
+### \_customProperties %{#Properties-\_customProperties}%
• **\_customProperties**: `Set`<`string`\>
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationDirect
-# Interface: SubscriptionCallbackMutationDirect %{#Interface:-SubscriptionCallbackMutationDirect}%
+# Interface: SubscriptionCallbackMutationDirect
[pinia](../modules/pinia.md).SubscriptionCallbackMutationDirect
a store with `store.someState = newValue` or `store.$state.someState =
newValue`.
-## Hierarchy %{#Interface:-SubscriptionCallbackMutationDirect-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md)
↳ **`SubscriptionCallbackMutationDirect`**
-## Properties %{#Interface:-SubscriptionCallbackMutationDirect-Properties}%
+## Properties %{#Properties}%
-### events %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events}%
+### events %{#Properties-events}%
• **events**: `DebuggerEvent`
https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in
devtools and plugins **during development only**.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events-Overrides}%
+#### Overrides %{#Properties-events-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events)
___
-### storeId %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId}%
+### storeId %{#Properties-storeId}%
• **storeId**: `string`
`id` of the store doing the mutation.
-#### Inherited from %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId-Inherited-from}%
+#### Inherited from %{#Properties-storeId-Inherited-from}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid)
___
-### type %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type}%
+### type %{#Properties-type}%
• **type**: [`direct`](../enums/pinia.MutationType.md#direct)
Type of the mutation.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type-Overrides}%
+#### Overrides %{#Properties-type-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchFunction
-# Interface: SubscriptionCallbackMutationPatchFunction %{#Interface:-SubscriptionCallbackMutationPatchFunction}%
+# Interface: SubscriptionCallbackMutationPatchFunction
[pinia](../modules/pinia.md).SubscriptionCallbackMutationPatchFunction
Context passed to a subscription callback when `store.$patch()` is called
with a function.
-## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchFunction-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md)
↳ **`SubscriptionCallbackMutationPatchFunction`**
-## Properties %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties}%
+## Properties %{#Properties}%
-### events %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events}%
+### events %{#Properties-events}%
• **events**: `DebuggerEvent`[]
https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in
devtools and plugins **during development only**.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events-Overrides}%
+#### Overrides %{#Properties-events-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events)
___
-### storeId %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId}%
+### storeId %{#Properties-storeId}%
• **storeId**: `string`
`id` of the store doing the mutation.
-#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId-Inherited-from}%
+#### Inherited from %{#Properties-storeId-Inherited-from}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid)
___
-### type %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type}%
+### type %{#Properties-type}%
• **type**: [`patchFunction`](../enums/pinia.MutationType.md#patchfunction)
Type of the mutation.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type-Overrides}%
+#### Overrides %{#Properties-type-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchObject
-# Interface: SubscriptionCallbackMutationPatchObject<S\> %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>}%
+# Interface: SubscriptionCallbackMutationPatchObject<S\>
[pinia](../modules/pinia.md).SubscriptionCallbackMutationPatchObject
Context passed to a subscription callback when `store.$patch()` is called
with an object.
-## Type parameters %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name |
| :------ |
| `S` |
-## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md)
↳ **`SubscriptionCallbackMutationPatchObject`**
-## Properties %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties}%
+## Properties %{#Properties}%
-### events %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-events}%
+### events %{#Properties-events}%
• **events**: `DebuggerEvent`[]
https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in
devtools and plugins **during development only**.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-events-Overrides}%
+#### Overrides %{#Properties-events-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events)
___
-### payload %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-payload}%
+### payload %{#Properties-payload}%
• **payload**: [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`S`\>
___
-### storeId %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-storeId}%
+### storeId %{#Properties-storeId}%
• **storeId**: `string`
`id` of the store doing the mutation.
-#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-storeId-Inherited-from}%
+#### Inherited from %{#Properties-storeId-Inherited-from}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid)
___
-### type %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-type}%
+### type %{#Properties-type}%
• **type**: [`patchObject`](../enums/pinia.MutationType.md#patchobject)
Type of the mutation.
-#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject<S\>-Properties-type-Overrides}%
+#### Overrides %{#Properties-type-Overrides}%
[_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext
-# Interface: \_StoreOnActionListenerContext<Store, ActionName, A\> %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>}%
+# Interface: \_StoreOnActionListenerContext<Store, ActionName, A\>
[pinia](../modules/pinia.md)._StoreOnActionListenerContext
purposes. For internal use only.
For internal use **only**
-## Type parameters %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `ActionName` | extends `string` |
| `A` | `A` |
-## Properties %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties}%
+## Properties %{#Properties}%
-### after %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-after}%
+### after %{#Properties-after}%
• **after**: (`callback`: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` : () => `void`) => `void`
-#### Type declaration %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-after-Type-declaration}%
+#### Type declaration %{#Properties-after-Type-declaration}%
▸ (`callback`): `void`
Sets up a hook once the action is finished. It receives the return value
of the action, if it's a Promise, it will be unwrapped.
-##### Parameters %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-after-Type-declaration-Parameters}%
+##### Parameters %{#Properties-after-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `callback` | `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` : () => `void` |
-##### Returns %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-after-Type-declaration-Returns}%
+##### Returns %{#Properties-after-Type-declaration-Returns}%
`void`
___
-### args %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-args}%
+### args %{#Properties-args}%
• **args**: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? `Parameters`<`A`[`ActionName`]\> : `unknown`[]
___
-### name %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-name}%
+### name %{#Properties-name}%
• **name**: `ActionName`
___
-### onError %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-onError}%
+### onError %{#Properties-onError}%
• **onError**: (`callback`: (`error`: `unknown`) => `void`) => `void`
-#### Type declaration %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-onError-Type-declaration}%
+#### Type declaration %{#Properties-onError-Type-declaration}%
▸ (`callback`): `void`
Sets up a hook if the action fails. Return `false` to catch the error and
stop it from propagating.
-##### Parameters %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-onError-Type-declaration-Parameters}%
+##### Parameters %{#Properties-onError-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `callback` | (`error`: `unknown`) => `void` |
-##### Returns %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-onError-Type-declaration-Returns}%
+##### Returns %{#Properties-onError-Type-declaration-Returns}%
`void`
___
-### store %{#Interface:-\_StoreOnActionListenerContext<Store,-ActionName,-A\>-Properties-store}%
+### store %{#Properties-store}%
• **store**: `Store`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreWithState
-# Interface: \_StoreWithState<Id, S, G, A\> %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>}%
+# Interface: \_StoreWithState<Id, S, G, A\>
[pinia](../modules/pinia.md)._StoreWithState
Base store with state and functions. Should not be used directly.
-## Type parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Type-parameters}%
+## Type parameters %{#Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | `G` |
| `A` | `A` |
-## Hierarchy %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`StoreProperties`](pinia.StoreProperties.md)<`Id`\>
↳ **`_StoreWithState`**
-## Properties %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties}%
+## Properties %{#Properties}%
-### $id %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties-$id}%
+### $id %{#Properties-$id}%
• **$id**: `Id`
Unique identifier of the store
-#### Inherited from %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties-$id-Inherited-from}%
+#### Inherited from %{#Properties-$id-Inherited-from}%
[StoreProperties](pinia.StoreProperties.md).[$id](pinia.StoreProperties.md#$id)
___
-### $state %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties-$state}%
+### $state %{#Properties-$state}%
• **$state**: `UnwrapRef`<`S`\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<`S`\>
___
-### \_customProperties %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties-\_customProperties}%
+### \_customProperties %{#Properties-\_customProperties}%
• **\_customProperties**: `Set`<`string`\>
in production. Can be used by the user to add property keys of the store
that should be displayed in devtools.
-#### Inherited from %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Properties-\_customProperties-Inherited-from}%
+#### Inherited from %{#Properties-\_customProperties-Inherited-from}%
[StoreProperties](pinia.StoreProperties.md).[_customProperties](pinia.StoreProperties.md#_customproperties)
-## Methods %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods}%
+## Methods %{#Methods}%
-### $dispose %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$dispose}%
+### $dispose %{#Methods-$dispose}%
▸ **$dispose**(): `void`
`delete pinia.state.value[store.$id]` if you want to. If you don't and the
store is used again, it will reuse the previous state.
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$dispose-Returns}%
+#### Returns %{#Methods-$dispose-Returns}%
`void`
___
-### $onAction %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$onAction}%
+### $onAction %{#Methods-$onAction}%
▸ **$onAction**(`callback`, `detached?`): () => `void`
})
```
-#### Parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$onAction-Parameters}%
+#### Parameters %{#Methods-$onAction-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | [`StoreOnActionListener`](../modules/pinia.md#storeonactionlistener)<`Id`, `S`, `G`, `A`\> | callback called before every action |
| `detached?` | `boolean` | detach the subscription from the context this is called from |
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$onAction-Returns}%
+#### Returns %{#Methods-$onAction-Returns}%
`fn`
})
```
-##### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$onAction-Returns-Returns}%
+##### Returns %{#Methods-$onAction-Returns-Returns}%
`void`
___
-### $patch %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch}%
+### $patch %{#Methods-$patch}%
▸ **$patch**(`partialState`): `void`
Applies a state patch to current state. Allows passing nested values
-#### Parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch-Parameters}%
+#### Parameters %{#Methods-$patch-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `partialState` | [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`UnwrapRef`<`S`\>\> | patch to apply to the state |
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch-Returns}%
+#### Returns %{#Methods-$patch-Returns}%
`void`
Sets or arrays and applying an object patch isn't practical, e.g. appending
to an array. The function passed to `$patch()` **must be synchronous**.
-#### Type parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch-Type-parameters}%
+#### Type parameters %{#Methods-$patch-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `F` | extends (`state`: `UnwrapRef`<`S`\>) => `any` |
-#### Parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch-Parameters_1}%
+#### Parameters %{#Methods-$patch-Parameters_1}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `stateMutator` | `ReturnType`<`F`\> extends `Promise`<`any`\> ? `never` : `F` | function that mutates `state`, cannot be async |
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$patch-Returns_1}%
+#### Returns %{#Methods-$patch-Returns_1}%
`void`
___
-### $reset %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$reset}%
+### $reset %{#Methods-$reset}%
▸ **$reset**(): `void`
Resets the store to its initial state by building a new state object.
TODO: make this options only
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$reset-Returns}%
+#### Returns %{#Methods-$reset-Returns}%
`void`
___
-### $subscribe %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$subscribe}%
+### $subscribe %{#Methods-$subscribe}%
▸ **$subscribe**(`callback`, `options?`): () => `void`
that when calling `store.$subscribe()` inside of a component, it will be automatically cleaned up when the
component gets unmounted unless `detached` is set to true.
-#### Parameters %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$subscribe-Parameters}%
+#### Parameters %{#Methods-$subscribe-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `callback` | [`SubscriptionCallback`](../modules/pinia.md#subscriptioncallback)<`S`\> | callback passed to the watcher |
| `options?` | { `detached?`: `boolean` } & `WatchOptions`<`boolean`\> | `watch` options + `detached` to detach the subscription from the context (usually a component) this is called from. Note that the `flush` option does not affect calls to `store.$patch()`. |
-#### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$subscribe-Returns}%
+#### Returns %{#Methods-$subscribe-Returns}%
`fn`
that when calling `store.$subscribe()` inside of a component, it will be automatically cleaned up when the
component gets unmounted unless `detached` is set to true.
-##### Returns %{#Interface:-\_StoreWithState<Id,-S,-G,-A\>-Methods-$subscribe-Returns-Returns}%
+##### Returns %{#Methods-$subscribe-Returns-Returns}%
`void`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_SubscriptionCallbackMutationBase
-# Interface: \_SubscriptionCallbackMutationBase %{#Interface:-\_SubscriptionCallbackMutationBase}%
+# Interface: \_SubscriptionCallbackMutationBase
[pinia](../modules/pinia.md)._SubscriptionCallbackMutationBase
Base type for the context passed to a subscription callback. Internal type.
-## Hierarchy %{#Interface:-\_SubscriptionCallbackMutationBase-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- **`_SubscriptionCallbackMutationBase`**
↳ [`SubscriptionCallbackMutationPatchObject`](pinia.SubscriptionCallbackMutationPatchObject.md)
-## Properties %{#Interface:-\_SubscriptionCallbackMutationBase-Properties}%
+## Properties %{#Properties}%
-### events %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-events}%
+### events %{#Properties-events}%
• `Optional` **events**: `DebuggerEvent` \| `DebuggerEvent`[]
___
-### storeId %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-storeId}%
+### storeId %{#Properties-storeId}%
• **storeId**: `string`
___
-### type %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-type}%
+### type %{#Properties-type}%
• **type**: [`MutationType`](../enums/pinia.MutationType.md)
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [@pinia/nuxt](../modules/pinia_nuxt.md) / ModuleOptions
-# Interface: ModuleOptions %{#Interface:-ModuleOptions}%
+# Interface: ModuleOptions
[@pinia/nuxt](../modules/pinia_nuxt.md).ModuleOptions
-## Properties %{#Interface:-ModuleOptions-Properties}%
+## Properties %{#Properties}%
-### autoImports %{#Interface:-ModuleOptions-Properties-autoImports}%
+### autoImports %{#Properties-autoImports}%
• `Optional` **autoImports**: (`string` \| [`string`, `string`])[]
___
-### disableVuex %{#Interface:-ModuleOptions-Properties-disableVuex}%
+### disableVuex %{#Properties-disableVuex}%
• `Optional` **disableVuex**: `boolean`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingOptions
-# Interface: TestingOptions %{#Interface:-TestingOptions}%
+# Interface: TestingOptions
[@pinia/testing](../modules/pinia_testing.md).TestingOptions
-## Properties %{#Interface:-TestingOptions-Properties}%
+## Properties %{#Properties}%
-### createSpy %{#Interface:-TestingOptions-Properties-createSpy}%
+### createSpy %{#Properties-createSpy}%
• `Optional` **createSpy**: (`fn?`: (...`args`: `any`[]) => `any`) => (...`args`: `any`[]) => `any`
-#### Type declaration %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration}%
+#### Type declaration %{#Properties-createSpy-Type-declaration}%
▸ (`fn?`): (...`args`: `any`[]) => `any`
Function used to create a spy for actions and `$patch()`. Pre-configured
with `jest.fn()` in jest projects or `vi.fn()` in vitest projects.
-##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters}%
+##### Parameters %{#Properties-createSpy-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `fn?` | (...`args`: `any`[]) => `any` |
-##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns}%
+##### Returns %{#Properties-createSpy-Type-declaration-Returns}%
`fn`
▸ (...`args`): `any`
-##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters_1}%
+##### Parameters %{#Properties-createSpy-Type-declaration-Parameters_1}%
| Name | Type |
| :------ | :------ |
| `...args` | `any`[] |
-##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns_1}%
+##### Returns %{#Properties-createSpy-Type-declaration-Returns_1}%
`any`
___
-### fakeApp %{#Interface:-TestingOptions-Properties-fakeApp}%
+### fakeApp %{#Properties-fakeApp}%
• `Optional` **fakeApp**: `boolean`
___
-### initialState %{#Interface:-TestingOptions-Properties-initialState}%
+### initialState %{#Properties-initialState}%
• `Optional` **initialState**: [`StateTree`](../modules/pinia.md#statetree)
___
-### plugins %{#Interface:-TestingOptions-Properties-plugins}%
+### plugins %{#Properties-plugins}%
• `Optional` **plugins**: [`PiniaPlugin`](pinia.PiniaPlugin.md)[]
___
-### stubActions %{#Interface:-TestingOptions-Properties-stubActions}%
+### stubActions %{#Properties-stubActions}%
• `Optional` **stubActions**: `boolean`
___
-### stubPatch %{#Interface:-TestingOptions-Properties-stubPatch}%
+### stubPatch %{#Properties-stubPatch}%
• `Optional` **stubPatch**: `boolean`
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingPinia
-# Interface: TestingPinia %{#Interface:-TestingPinia}%
+# Interface: TestingPinia
[@pinia/testing](../modules/pinia_testing.md).TestingPinia
Pinia instance specifically designed for testing. Extends a regular
`Pinia` instance with test specific properties.
-## Hierarchy %{#Interface:-TestingPinia-Hierarchy}%
+## Hierarchy %{#Hierarchy}%
- [`Pinia`](pinia.Pinia.md)
↳ **`TestingPinia`**
-## Properties %{#Interface:-TestingPinia-Properties}%
+## Properties %{#Properties}%
-### app %{#Interface:-TestingPinia-Properties-app}%
+### app %{#Properties-app}%
• **app**: `App`<`any`\>
___
-### install %{#Interface:-TestingPinia-Properties-install}%
+### install %{#Properties-install}%
• **install**: (`app`: `App`<`any`\>) => `void`
-#### Type declaration %{#Interface:-TestingPinia-Properties-install-Type-declaration}%
+#### Type declaration %{#Properties-install-Type-declaration}%
▸ (`app`): `void`
-##### Parameters %{#Interface:-TestingPinia-Properties-install-Type-declaration-Parameters}%
+##### Parameters %{#Properties-install-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `app` | `App`<`any`\> |
-##### Returns %{#Interface:-TestingPinia-Properties-install-Type-declaration-Returns}%
+##### Returns %{#Properties-install-Type-declaration-Returns}%
`void`
-#### Inherited from %{#Interface:-TestingPinia-Properties-install-Inherited-from}%
+#### Inherited from %{#Properties-install-Inherited-from}%
[Pinia](pinia.Pinia.md).[install](pinia.Pinia.md#install)
___
-### state %{#Interface:-TestingPinia-Properties-state}%
+### state %{#Properties-state}%
• **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\>
root state
-#### Inherited from %{#Interface:-TestingPinia-Properties-state-Inherited-from}%
+#### Inherited from %{#Properties-state-Inherited-from}%
[Pinia](pinia.Pinia.md).[state](pinia.Pinia.md#state)
-## Methods %{#Interface:-TestingPinia-Methods}%
+## Methods %{#Methods}%
-### use %{#Interface:-TestingPinia-Methods-use}%
+### use %{#Methods-use}%
▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md)
Adds a store plugin to extend every store
-#### Parameters %{#Interface:-TestingPinia-Methods-use-Parameters}%
+#### Parameters %{#Methods-use-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add |
-#### Returns %{#Interface:-TestingPinia-Methods-use-Returns}%
+#### Returns %{#Methods-use-Returns}%
[`Pinia`](pinia.Pinia.md)
-#### Inherited from %{#Interface:-TestingPinia-Methods-use-Inherited-from}%
+#### Inherited from %{#Methods-use-Inherited-from}%
[Pinia](pinia.Pinia.md).[use](pinia.Pinia.md#use)
---
-sidebar: "auto"
-editLinks: false
-sidebarDepth: 3
+editLink: false
+outline: [2, 3]
---
[API Documentation](../index.md) / pinia
-# Module: pinia %{#Module:-pinia}%
+# Module: pinia
-## Enumerations %{#Module:-pinia-Enumerations}%
+## Enumerations %{#Enumerations}%
- [MutationType](../enums/pinia.MutationType.md)
-## Interfaces %{#Module:-pinia-Interfaces}%
+## Interfaces %{#Interfaces}%
- [DefineSetupStoreOptions](../interfaces/pinia.DefineSetupStoreOptions.md)
- [DefineStoreOptions](../interfaces/pinia.DefineStoreOptions.md)
- [\_StoreWithState](../interfaces/pinia._StoreWithState.md)
- [\_SubscriptionCallbackMutationBase](../interfaces/pinia._SubscriptionCallbackMutationBase.md)
-## Type Aliases %{#Module:-pinia-Type-Aliases}%
+## Type Aliases %{#Type-Aliases}%
-### PiniaStorePlugin %{#Module:-pinia-Type-Aliases-PiniaStorePlugin}%
+### PiniaStorePlugin %{#Type-Aliases-PiniaStorePlugin}%
Ƭ **PiniaStorePlugin**: [`PiniaPlugin`](../interfaces/pinia.PiniaPlugin.md)
___
-### StateTree %{#Module:-pinia-Type-Aliases-StateTree}%
+### StateTree %{#Type-Aliases-StateTree}%
Ƭ **StateTree**: `Record`<`string` \| `number` \| `symbol`, `any`\>
___
-### Store %{#Module:-pinia-Type-Aliases-Store}%
+### Store %{#Type-Aliases-Store}%
Ƭ **Store**<`Id`, `S`, `G`, `A`\>: [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & `UnwrapRef`<`S`\> & [`_StoreWithGetters`](pinia.md#_storewithgetters)<`G`\> & [`_ActionsTree`](pinia.md#_actionstree) extends `A` ? {} : `A` & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`Id`, `S`, `G`, `A`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<`S`\>
Store type to build a store.
-#### Type parameters %{#Module:-pinia-Type-Aliases-Store-Type-parameters}%
+#### Type parameters %{#Type-Aliases-Store-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### StoreActions %{#Module:-pinia-Type-Aliases-StoreActions}%
+### StoreActions %{#Type-Aliases-StoreActions}%
Ƭ **StoreActions**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, infer A\> ? `A` : [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>
Extract the actions of a store type. Works with both a Setup Store or an
Options Store.
-#### Type parameters %{#Module:-pinia-Type-Aliases-StoreActions-Type-parameters}%
+#### Type parameters %{#Type-Aliases-StoreActions-Type-parameters}%
| Name |
| :------ |
___
-### StoreGeneric %{#Module:-pinia-Type-Aliases-StoreGeneric}%
+### StoreGeneric %{#Type-Aliases-StoreGeneric}%
Ƭ **StoreGeneric**: [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\>
___
-### StoreGetters %{#Module:-pinia-Type-Aliases-StoreGetters}%
+### StoreGetters %{#Type-Aliases-StoreGetters}%
Ƭ **StoreGetters**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), infer G, [`_ActionsTree`](pinia.md#_actionstree)\> ? [`_StoreWithGetters`](pinia.md#_storewithgetters)<`G`\> : [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>
Extract the getters of a store type. Works with both a Setup Store or an
Options Store.
-#### Type parameters %{#Module:-pinia-Type-Aliases-StoreGetters-Type-parameters}%
+#### Type parameters %{#Type-Aliases-StoreGetters-Type-parameters}%
| Name |
| :------ |
___
-### StoreOnActionListener %{#Module:-pinia-Type-Aliases-StoreOnActionListener}%
+### StoreOnActionListener %{#Type-Aliases-StoreOnActionListener}%
Ƭ **StoreOnActionListener**<`Id`, `S`, `G`, `A`\>: (`context`: [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\>) => `void`
-#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-parameters}%
+#### Type parameters %{#Type-Aliases-StoreOnActionListener-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | `G` |
| `A` | `A` |
-#### Type declaration %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration}%
+#### Type declaration %{#Type-Aliases-StoreOnActionListener-Type-declaration}%
▸ (`context`): `void`
Argument of `store.$onAction()`
-##### Parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Parameters}%
+##### Parameters %{#Type-Aliases-StoreOnActionListener-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\> |
-##### Returns %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Returns}%
+##### Returns %{#Type-Aliases-StoreOnActionListener-Type-declaration-Returns}%
`void`
___
-### StoreOnActionListenerContext %{#Module:-pinia-Type-Aliases-StoreOnActionListenerContext}%
+### StoreOnActionListenerContext %{#Type-Aliases-StoreOnActionListenerContext}%
Ƭ **StoreOnActionListenerContext**<`Id`, `S`, `G`, `A`\>: [`_ActionsTree`](pinia.md#_actionstree) extends `A` ? [`_StoreOnActionListenerContext`](../interfaces/pinia._StoreOnActionListenerContext.md)<[`StoreGeneric`](pinia.md#storegeneric), `string`, [`_ActionsTree`](pinia.md#_actionstree)\> : { [Name in keyof A]: Name extends string ? \_StoreOnActionListenerContext<Store<Id, S, G, A\>, Name, A\> : never }[keyof `A`]
Context object passed to callbacks of `store.$onAction(context => {})`
TODO: should have only the Id, the Store and Actions to generate the proper object
-#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListenerContext-Type-parameters}%
+#### Type parameters %{#Type-Aliases-StoreOnActionListenerContext-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### StoreState %{#Module:-pinia-Type-Aliases-StoreState}%
+### StoreState %{#Type-Aliases-StoreState}%
Ƭ **StoreState**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, infer S, [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> ? `UnwrapRef`<`S`\> : [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>
Extract the state of a store type. Works with both a Setup Store or an
Options Store. Note this unwraps refs.
-#### Type parameters %{#Module:-pinia-Type-Aliases-StoreState-Type-parameters}%
+#### Type parameters %{#Type-Aliases-StoreState-Type-parameters}%
| Name |
| :------ |
___
-### SubscriptionCallback %{#Module:-pinia-Type-Aliases-SubscriptionCallback}%
+### SubscriptionCallback %{#Type-Aliases-SubscriptionCallback}%
Ƭ **SubscriptionCallback**<`S`\>: (`mutation`: [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\>, `state`: `UnwrapRef`<`S`\>) => `void`
-#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-parameters}%
+#### Type parameters %{#Type-Aliases-SubscriptionCallback-Type-parameters}%
| Name |
| :------ |
| `S` |
-#### Type declaration %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration}%
+#### Type declaration %{#Type-Aliases-SubscriptionCallback-Type-declaration}%
▸ (`mutation`, `state`): `void`
Callback of a subscription
-##### Parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Parameters}%
+##### Parameters %{#Type-Aliases-SubscriptionCallback-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `mutation` | [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\> |
| `state` | `UnwrapRef`<`S`\> |
-##### Returns %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Returns}%
+##### Returns %{#Type-Aliases-SubscriptionCallback-Type-declaration-Returns}%
`void`
___
-### SubscriptionCallbackMutation %{#Module:-pinia-Type-Aliases-SubscriptionCallbackMutation}%
+### SubscriptionCallbackMutation %{#Type-Aliases-SubscriptionCallbackMutation}%
Ƭ **SubscriptionCallbackMutation**<`S`\>: [`SubscriptionCallbackMutationDirect`](../interfaces/pinia.SubscriptionCallbackMutationDirect.md) \| [`SubscriptionCallbackMutationPatchObject`](../interfaces/pinia.SubscriptionCallbackMutationPatchObject.md)<`S`\> \| [`SubscriptionCallbackMutationPatchFunction`](../interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md)
Context object passed to a subscription callback.
-#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallbackMutation-Type-parameters}%
+#### Type parameters %{#Type-Aliases-SubscriptionCallbackMutation-Type-parameters}%
| Name |
| :------ |
___
-### \_ActionsTree %{#Module:-pinia-Type-Aliases-\_ActionsTree}%
+### \_ActionsTree %{#Type-Aliases-\_ActionsTree}%
Ƭ **\_ActionsTree**: `Record`<`string`, [`_Method`](pinia.md#_method)\>
___
-### \_Awaited %{#Module:-pinia-Type-Aliases-\_Awaited}%
+### \_Awaited %{#Type-Aliases-\_Awaited}%
Ƭ **\_Awaited**<`T`\>: `T` extends ``null`` \| `undefined` ? `T` : `T` extends `object` & { `then`: (`onfulfilled`: `F`) => `any` } ? `F` extends (`value`: infer V, ...`args`: `any`) => `any` ? [`_Awaited`](pinia.md#_awaited)<`V`\> : `never` : `T`
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_Awaited-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_Awaited-Type-parameters}%
| Name |
| :------ |
___
-### \_DeepPartial %{#Module:-pinia-Type-Aliases-\_DeepPartial}%
+### \_DeepPartial %{#Type-Aliases-\_DeepPartial}%
Ƭ **\_DeepPartial**<`T`\>: { [K in keyof T]?: \_DeepPartial<T[K]\> }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_DeepPartial-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_DeepPartial-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractActionsFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore}%
+### \_ExtractActionsFromSetupStore %{#Type-Aliases-\_ExtractActionsFromSetupStore}%
Ƭ **\_ExtractActionsFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractActionsFromSetupStore_Keys`](pinia.md#_extractactionsfromsetupstore_keys)<`SS`\> extends keyof `SS` ? `Pick`<`SS`, [`_ExtractActionsFromSetupStore_Keys`](pinia.md#_extractactionsfromsetupstore_keys)<`SS`\>\> : `never`
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractActionsFromSetupStore-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractActionsFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore\_Keys}%
+### \_ExtractActionsFromSetupStore\_Keys %{#Type-Aliases-\_ExtractActionsFromSetupStore\_Keys}%
Ƭ **\_ExtractActionsFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends \_Method ? K : never]: any }
Type that enables refactoring through IDE.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore\_Keys-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractActionsFromSetupStore\_Keys-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractGettersFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore}%
+### \_ExtractGettersFromSetupStore %{#Type-Aliases-\_ExtractGettersFromSetupStore}%
Ƭ **\_ExtractGettersFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\> extends keyof `SS` ? `Pick`<`SS`, [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\>\> : `never`
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractGettersFromSetupStore-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractGettersFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore\_Keys}%
+### \_ExtractGettersFromSetupStore\_Keys %{#Type-Aliases-\_ExtractGettersFromSetupStore\_Keys}%
Ƭ **\_ExtractGettersFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends ComputedRef ? K : never]: any }
Type that enables refactoring through IDE.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore\_Keys-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractGettersFromSetupStore\_Keys-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractStateFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore}%
+### \_ExtractStateFromSetupStore %{#Type-Aliases-\_ExtractStateFromSetupStore}%
Ƭ **\_ExtractStateFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractStateFromSetupStore_Keys`](pinia.md#_extractstatefromsetupstore_keys)<`SS`\> extends keyof `SS` ? [`_UnwrapAll`](pinia.md#_unwrapall)<`Pick`<`SS`, [`_ExtractStateFromSetupStore_Keys`](pinia.md#_extractstatefromsetupstore_keys)<`SS`\>\>\> : `never`
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractStateFromSetupStore-Type-parameters}%
| Name |
| :------ |
___
-### \_ExtractStateFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore\_Keys}%
+### \_ExtractStateFromSetupStore\_Keys %{#Type-Aliases-\_ExtractStateFromSetupStore\_Keys}%
Ƭ **\_ExtractStateFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends \_Method \| ComputedRef ? never : K]: any }
Type that enables refactoring through IDE.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore\_Keys-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_ExtractStateFromSetupStore\_Keys-Type-parameters}%
| Name |
| :------ |
___
-### \_GettersTree %{#Module:-pinia-Type-Aliases-\_GettersTree}%
+### \_GettersTree %{#Type-Aliases-\_GettersTree}%
Ƭ **\_GettersTree**<`S`\>: `Record`<`string`, (`state`: `UnwrapRef`<`S`\> & `UnwrapRef`<[`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<`S`\>\>) => `any` \| () => `any`\>
Type of an object of Getters that infers the argument. For internal usage only.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_GettersTree-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_GettersTree-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_MapActionsObjectReturn %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn}%
+### \_MapActionsObjectReturn %{#Type-Aliases-\_MapActionsObjectReturn}%
Ƭ **\_MapActionsObjectReturn**<`A`, `T`\>: { [key in keyof T]: A[T[key]] }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapActionsObjectReturn-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_MapActionsReturn %{#Module:-pinia-Type-Aliases-\_MapActionsReturn}%
+### \_MapActionsReturn %{#Type-Aliases-\_MapActionsReturn}%
Ƭ **\_MapActionsReturn**<`A`\>: { [key in keyof A]: A[key] }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapActionsReturn-Type-parameters}%
| Name |
| :------ |
___
-### \_MapStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn}%
+### \_MapStateObjectReturn %{#Type-Aliases-\_MapStateObjectReturn}%
Ƭ **\_MapStateObjectReturn**<`Id`, `S`, `G`, `A`, `T`\>: { [key in keyof T]: Function }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapStateObjectReturn-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_MapStateReturn %{#Module:-pinia-Type-Aliases-\_MapStateReturn}%
+### \_MapStateReturn %{#Type-Aliases-\_MapStateReturn}%
Ƭ **\_MapStateReturn**<`S`, `G`, `Keys`\>: { [key in Keys]: Function }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapStateReturn-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_MapWritableStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn}%
+### \_MapWritableStateObjectReturn %{#Type-Aliases-\_MapWritableStateObjectReturn}%
Ƭ **\_MapWritableStateObjectReturn**<`S`, `T`\>: { [key in keyof T]: Object }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapWritableStateObjectReturn-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_MapWritableStateReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn}%
+### \_MapWritableStateReturn %{#Type-Aliases-\_MapWritableStateReturn}%
Ƭ **\_MapWritableStateReturn**<`S`\>: { [key in keyof S]: Object }
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_MapWritableStateReturn-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_Method %{#Module:-pinia-Type-Aliases-\_Method}%
+### \_Method %{#Type-Aliases-\_Method}%
Ƭ **\_Method**: (...`args`: `any`[]) => `any`
-#### Type declaration %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration}%
+#### Type declaration %{#Type-Aliases-\_Method-Type-declaration}%
▸ (...`args`): `any`
For internal use **only**
-##### Parameters %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Parameters}%
+##### Parameters %{#Type-Aliases-\_Method-Type-declaration-Parameters}%
| Name | Type |
| :------ | :------ |
| `...args` | `any`[] |
-##### Returns %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Returns}%
+##### Returns %{#Type-Aliases-\_Method-Type-declaration-Returns}%
`any`
___
-### \_Spread %{#Module:-pinia-Type-Aliases-\_Spread}%
+### \_Spread %{#Type-Aliases-\_Spread}%
Ƭ **\_Spread**<`A`\>: `A` extends [infer L, ...(infer R)] ? [`_StoreObject`](pinia.md#_storeobject)<`L`\> & [`_Spread`](pinia.md#_spread)<`R`\> : `unknown`
For internal use **only**.
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_Spread-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_Spread-Type-parameters}%
| Name | Type |
| :------ | :------ |
___
-### \_StoreObject %{#Module:-pinia-Type-Aliases-\_StoreObject}%
+### \_StoreObject %{#Type-Aliases-\_StoreObject}%
Ƭ **\_StoreObject**<`S`\>: `S` extends [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<infer Ids, infer State, infer Getters, infer Actions\> ? { [Id in \`${Ids}${MapStoresCustomization extends Record<"suffix", infer Suffix\> ? Suffix : "Store"}\`]: Function } : {}
For internal use **only**.
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreObject-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_StoreObject-Type-parameters}%
| Name |
| :------ |
___
-### \_StoreWithActions %{#Module:-pinia-Type-Aliases-\_StoreWithActions}%
+### \_StoreWithActions %{#Type-Aliases-\_StoreWithActions}%
Ƭ **\_StoreWithActions**<`A`\>: { [k in keyof A]: A[k] extends Function ? Function : never }
Store augmented for actions. For internal usage only.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithActions-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_StoreWithActions-Type-parameters}%
| Name |
| :------ |
___
-### \_StoreWithGetters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters}%
+### \_StoreWithGetters %{#Type-Aliases-\_StoreWithGetters}%
Ƭ **\_StoreWithGetters**<`G`\>: { readonly [k in keyof G]: G[k] extends Function ? R : UnwrapRef<G[k]\> }
Store augmented with getters. For internal usage only.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_StoreWithGetters-Type-parameters}%
| Name |
| :------ |
___
-### \_UnwrapAll %{#Module:-pinia-Type-Aliases-\_UnwrapAll}%
+### \_UnwrapAll %{#Type-Aliases-\_UnwrapAll}%
Ƭ **\_UnwrapAll**<`SS`\>: { [K in keyof SS]: UnwrapRef<SS[K]\> }
Type that enables refactoring through IDE.
For internal use **only**
-#### Type parameters %{#Module:-pinia-Type-Aliases-\_UnwrapAll-Type-parameters}%
+#### Type parameters %{#Type-Aliases-\_UnwrapAll-Type-parameters}%
| Name |
| :------ |
| `SS` |
-## Variables %{#Module:-pinia-Variables}%
+## Variables %{#Variables}%
-### PiniaVuePlugin %{#Module:-pinia-Variables-PiniaVuePlugin}%
+### PiniaVuePlugin %{#Variables-PiniaVuePlugin}%
• `Const` **PiniaVuePlugin**: `Plugin`
Vue 2 Plugin that must be installed for pinia to work. Note **you don't need
this plugin if you are using Nuxt.js**. Use the `buildModule` instead:
-https://pinia.vuejs.org/ssr/nuxt.html.
+<https://pinia.vuejs.org/ssr/nuxt.html>.
**`Example`**
`Vue` imported from 'vue'.
-## Functions %{#Module:-pinia-Functions}%
+## Functions %{#Functions}%
-### acceptHMRUpdate %{#Module:-pinia-Functions-acceptHMRUpdate}%
+### acceptHMRUpdate %{#Functions-acceptHMRUpdate}%
▸ **acceptHMRUpdate**(`initialUseStore`, `hot`): (`newModule`: `any`) => `any`
}
```
-#### Parameters %{#Module:-pinia-Functions-acceptHMRUpdate-Parameters}%
+#### Parameters %{#Functions-acceptHMRUpdate-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `initialUseStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> | return of the defineStore to hot update |
| `hot` | `any` | `import.meta.hot` |
-#### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns}%
+#### Returns %{#Functions-acceptHMRUpdate-Returns}%
`fn`
▸ (`newModule`): `any`
-##### Parameters %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Parameters}%
+##### Parameters %{#Functions-acceptHMRUpdate-Returns-Parameters}%
| Name | Type |
| :------ | :------ |
| `newModule` | `any` |
-##### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Returns}%
+##### Returns %{#Functions-acceptHMRUpdate-Returns-Returns}%
`any`
___
-### createPinia %{#Module:-pinia-Functions-createPinia}%
+### createPinia %{#Functions-createPinia}%
▸ **createPinia**(): [`Pinia`](../interfaces/pinia.Pinia.md)
Creates a Pinia instance to be used by the application
-#### Returns %{#Module:-pinia-Functions-createPinia-Returns}%
+#### Returns %{#Functions-createPinia-Returns}%
[`Pinia`](../interfaces/pinia.Pinia.md)
___
-### defineStore %{#Module:-pinia-Functions-defineStore}%
+### defineStore %{#Functions-defineStore}%
▸ **defineStore**<`Id`, `S`, `G`, `A`\>(`id`, `options`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\>
Creates a `useStore` function that retrieves the store instance
-#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters}%
+#### Type parameters %{#Functions-defineStore-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} |
| `A` | {} |
-#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters}%
+#### Parameters %{#Functions-defineStore-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `id` | `Id` | id of the store (must be unique) |
| `options` | `Omit`<[`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\>, ``"id"``\> | options to define the store |
-#### Returns %{#Module:-pinia-Functions-defineStore-Returns}%
+#### Returns %{#Functions-defineStore-Returns}%
[`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\>
Creates a `useStore` function that retrieves the store instance
-#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_1}%
+#### Type parameters %{#Functions-defineStore-Type-parameters_1}%
| Name | Type |
| :------ | :------ |
| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} |
| `A` | {} |
-#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_1}%
+#### Parameters %{#Functions-defineStore-Parameters_1}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `options` | [`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\> | options to define the store |
-#### Returns %{#Module:-pinia-Functions-defineStore-Returns_1}%
+#### Returns %{#Functions-defineStore-Returns_1}%
[`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\>
Creates a `useStore` function that retrieves the store instance
-#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_2}%
+#### Type parameters %{#Functions-defineStore-Type-parameters_2}%
| Name | Type |
| :------ | :------ |
| `Id` | extends `string` |
| `SS` | `SS` |
-#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_2}%
+#### Parameters %{#Functions-defineStore-Parameters_2}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `storeSetup` | () => `SS` | function that defines the store |
| `options?` | [`DefineSetupStoreOptions`](../interfaces/pinia.DefineSetupStoreOptions.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> | extra options |
-#### Returns %{#Module:-pinia-Functions-defineStore-Returns_2}%
+#### Returns %{#Functions-defineStore-Returns_2}%
[`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\>
___
-### getActivePinia %{#Module:-pinia-Functions-getActivePinia}%
+### getActivePinia %{#Functions-getActivePinia}%
▸ **getActivePinia**(): `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md)
Get the currently active pinia if there is any.
-#### Returns %{#Module:-pinia-Functions-getActivePinia-Returns}%
+#### Returns %{#Functions-getActivePinia-Returns}%
`undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md)
___
-### mapActions %{#Module:-pinia-Functions-mapActions}%
+### mapActions %{#Functions-mapActions}%
▸ **mapActions**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\>
}
```
-#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters}%
+#### Type parameters %{#Functions-mapActions-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `KeyMapper` | extends `Record`<`string`, keyof `A`\> |
-#### Parameters %{#Module:-pinia-Functions-mapActions-Parameters}%
+#### Parameters %{#Functions-mapActions-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keyMapper` | `KeyMapper` | object to define new names for the actions |
-#### Returns %{#Module:-pinia-Functions-mapActions-Returns}%
+#### Returns %{#Functions-mapActions-Returns}%
[`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\>
}
```
-#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters_1}%
+#### Type parameters %{#Functions-mapActions-Type-parameters_1}%
| Name | Type |
| :------ | :------ |
| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> |
| `A` | `A` |
-#### Parameters %{#Module:-pinia-Functions-mapActions-Parameters_1}%
+#### Parameters %{#Functions-mapActions-Parameters_1}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keys` | keyof `A`[] | array of action names to map |
-#### Returns %{#Module:-pinia-Functions-mapActions-Returns_1}%
+#### Returns %{#Functions-mapActions-Returns_1}%
[`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\>
___
-### mapGetters %{#Module:-pinia-Functions-mapGetters}%
+### mapGetters %{#Functions-mapGetters}%
▸ **mapGetters**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\>
use `mapState()` instead.
-#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters}%
+#### Type parameters %{#Functions-mapGetters-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> |
-#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters}%
+#### Parameters %{#Functions-mapGetters-Parameters}%
| Name | Type |
| :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> |
| `keyMapper` | `KeyMapper` |
-#### Returns %{#Module:-pinia-Functions-mapGetters-Returns}%
+#### Returns %{#Functions-mapGetters-Returns}%
[`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\>
use `mapState()` instead.
-#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters_1}%
+#### Type parameters %{#Functions-mapGetters-Type-parameters_1}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `Keys` | extends `string` \| `number` \| `symbol` |
-#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters_1}%
+#### Parameters %{#Functions-mapGetters-Parameters_1}%
| Name | Type |
| :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> |
| `keys` | readonly `Keys`[] |
-#### Returns %{#Module:-pinia-Functions-mapGetters-Returns_1}%
+#### Returns %{#Functions-mapGetters-Returns_1}%
[`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\>
___
-### mapState %{#Module:-pinia-Functions-mapState}%
+### mapState %{#Functions-mapState}%
▸ **mapState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\>
}
```
-#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters}%
+#### Type parameters %{#Functions-mapState-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> |
-#### Parameters %{#Module:-pinia-Functions-mapState-Parameters}%
+#### Parameters %{#Functions-mapState-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keyMapper` | `KeyMapper` | object of state properties or getters |
-#### Returns %{#Module:-pinia-Functions-mapState-Returns}%
+#### Returns %{#Functions-mapState-Returns}%
[`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\>
}
```
-#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters_1}%
+#### Type parameters %{#Functions-mapState-Type-parameters_1}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `Keys` | extends `string` \| `number` \| `symbol` |
-#### Parameters %{#Module:-pinia-Functions-mapState-Parameters_1}%
+#### Parameters %{#Functions-mapState-Parameters_1}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keys` | readonly `Keys`[] | array of state properties or getters |
-#### Returns %{#Module:-pinia-Functions-mapState-Returns_1}%
+#### Returns %{#Functions-mapState-Returns_1}%
[`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\>
___
-### mapStores %{#Module:-pinia-Functions-mapStores}%
+### mapStores %{#Functions-mapStores}%
▸ **mapStores**<`Stores`\>(...`stores`): [`_Spread`](pinia.md#_spread)<`Stores`\>
}
```
-#### Type parameters %{#Module:-pinia-Functions-mapStores-Type-parameters}%
+#### Type parameters %{#Functions-mapStores-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `Stores` | extends `any`[] |
-#### Parameters %{#Module:-pinia-Functions-mapStores-Parameters}%
+#### Parameters %{#Functions-mapStores-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `...stores` | [...Stores[]] | list of stores to map to an object |
-#### Returns %{#Module:-pinia-Functions-mapStores-Returns}%
+#### Returns %{#Functions-mapStores-Returns}%
[`_Spread`](pinia.md#_spread)<`Stores`\>
___
-### mapWritableState %{#Module:-pinia-Functions-mapWritableState}%
+### mapWritableState %{#Functions-mapWritableState}%
▸ **mapWritableState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\>
modified. Differently from `mapState()`, only `state` properties can be
added.
-#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters}%
+#### Type parameters %{#Functions-mapWritableState-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `A` | `A` |
| `KeyMapper` | extends `Record`<`string`, keyof `S`\> |
-#### Parameters %{#Module:-pinia-Functions-mapWritableState-Parameters}%
+#### Parameters %{#Functions-mapWritableState-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keyMapper` | `KeyMapper` | object of state properties |
-#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns}%
+#### Returns %{#Functions-mapWritableState-Returns}%
[`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\>
API (`setup()`) by generating an object to be spread in the `computed` field
of a component.
-#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters_1}%
+#### Type parameters %{#Functions-mapWritableState-Type-parameters_1}%
| Name | Type |
| :------ | :------ |
| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> |
| `A` | `A` |
-#### Parameters %{#Module:-pinia-Functions-mapWritableState-Parameters_1}%
+#### Parameters %{#Functions-mapWritableState-Parameters_1}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from |
| `keys` | keyof `S`[] | array of state properties |
-#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns_1}%
+#### Returns %{#Functions-mapWritableState-Returns_1}%
[`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\>
___
-### setActivePinia %{#Module:-pinia-Functions-setActivePinia}%
+### setActivePinia %{#Functions-setActivePinia}%
▸ **setActivePinia**(`pinia`): `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md)
Sets or unsets the active pinia. Used in SSR and internally when calling
actions and getters
-#### Parameters %{#Module:-pinia-Functions-setActivePinia-Parameters}%
+#### Parameters %{#Functions-setActivePinia-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `pinia` | `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) | Pinia instance |
-#### Returns %{#Module:-pinia-Functions-setActivePinia-Returns}%
+#### Returns %{#Functions-setActivePinia-Returns}%
`undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md)
___
-### setMapStoreSuffix %{#Module:-pinia-Functions-setMapStoreSuffix}%
+### setMapStoreSuffix %{#Functions-setMapStoreSuffix}%
▸ **setMapStoreSuffix**(`suffix`): `void`
Defaults to `"Store"`. Make sure to extend the MapStoresCustomization
interface if you are using TypeScript.
-#### Parameters %{#Module:-pinia-Functions-setMapStoreSuffix-Parameters}%
+#### Parameters %{#Functions-setMapStoreSuffix-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `suffix` | `string` | new suffix |
-#### Returns %{#Module:-pinia-Functions-setMapStoreSuffix-Returns}%
+#### Returns %{#Functions-setMapStoreSuffix-Returns}%
`void`
___
-### skipHydrate %{#Module:-pinia-Functions-skipHydrate}%
+### skipHydrate %{#Functions-skipHydrate}%
▸ **skipHydrate**<`T`\>(`obj`): `T`
Tells Pinia to skip the hydration process of a given object. This is useful in setup stores (only) when you return a
stateful object in the store but it isn't really state. e.g. returning a router instance in a setup store.
-#### Type parameters %{#Module:-pinia-Functions-skipHydrate-Type-parameters}%
+#### Type parameters %{#Functions-skipHydrate-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `T` | `any` |
-#### Parameters %{#Module:-pinia-Functions-skipHydrate-Parameters}%
+#### Parameters %{#Functions-skipHydrate-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `obj` | `T` | target object |
-#### Returns %{#Module:-pinia-Functions-skipHydrate-Returns}%
+#### Returns %{#Functions-skipHydrate-Returns}%
`T`
___
-### storeToRefs %{#Module:-pinia-Functions-storeToRefs}%
+### storeToRefs %{#Functions-storeToRefs}%
▸ **storeToRefs**<`SS`\>(`store`): `StoreToRefs`<`SS`\>
designed for Pinia stores so methods and non reactive properties are
completely ignored.
-#### Type parameters %{#Module:-pinia-Functions-storeToRefs-Type-parameters}%
+#### Type parameters %{#Functions-storeToRefs-Type-parameters}%
| Name | Type |
| :------ | :------ |
| `SS` | extends [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree), `SS`\> & [`StateTree`](pinia.md#statetree) & [`_StoreWithGetters`](pinia.md#_storewithgetters)<[`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>\> & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree), `SS`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<[`StateTree`](pinia.md#statetree), `SS`\> |
-#### Parameters %{#Module:-pinia-Functions-storeToRefs-Parameters}%
+#### Parameters %{#Functions-storeToRefs-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `store` | `SS` | store to extract the refs from |
-#### Returns %{#Module:-pinia-Functions-storeToRefs-Returns}%
+#### Returns %{#Functions-storeToRefs-Returns}%
`StoreToRefs`<`SS`\>
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / @pinia/nuxt
-# Module: @pinia/nuxt %{#Module:-@pinia/nuxt}%
+# Module: @pinia/nuxt
-## Interfaces %{#Module:-@pinia/nuxt-Interfaces}%
+## Interfaces %{#Interfaces}%
- [ModuleOptions](../interfaces/pinia_nuxt.ModuleOptions.md)
-## Functions %{#Module:-@pinia/nuxt-Functions}%
+## Functions %{#Functions}%
-### default %{#Module:-@pinia/nuxt-Functions-default}%
+### default %{#Functions-default}%
▸ **default**(`this`, `inlineOptions`, `nuxt`): `void` \| `Promise`<`void`\>
-#### Parameters %{#Module:-@pinia/nuxt-Functions-default-Parameters}%
+#### Parameters %{#Functions-default-Parameters}%
| Name | Type |
| :------ | :------ |
| `inlineOptions` | [`ModuleOptions`](../interfaces/pinia_nuxt.ModuleOptions.md) |
| `nuxt` | `Nuxt` |
-#### Returns %{#Module:-@pinia/nuxt-Functions-default-Returns}%
+#### Returns %{#Functions-default-Returns}%
`void` \| `Promise`<`void`\>
---
sidebar: "auto"
-editLinks: false
+editLink: false
sidebarDepth: 3
---
[API Documentation](../index.md) / @pinia/testing
-# Module: @pinia/testing %{#Module:-@pinia/testing}%
+# Module: @pinia/testing
-## Interfaces %{#Module:-@pinia/testing-Interfaces}%
+## Interfaces %{#Interfaces}%
- [TestingOptions](../interfaces/pinia_testing.TestingOptions.md)
- [TestingPinia](../interfaces/pinia_testing.TestingPinia.md)
-## Functions %{#Module:-@pinia/testing-Functions}%
+## Functions %{#Functions}%
-### createTestingPinia %{#Module:-@pinia/testing-Functions-createTestingPinia}%
+### createTestingPinia %{#Functions-createTestingPinia}%
▸ **createTestingPinia**(`options?`): [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md)
they are replaced with `jest.fn()`, otherwise, you must provide your own
`createSpy` option.
-#### Parameters %{#Module:-@pinia/testing-Functions-createTestingPinia-Parameters}%
+#### Parameters %{#Functions-createTestingPinia-Parameters}%
| Name | Type | Description |
| :------ | :------ | :------ |
| `options` | [`TestingOptions`](../interfaces/pinia_testing.TestingOptions.md) | options to configure the testing pinia |
-#### Returns %{#Module:-@pinia/testing-Functions-createTestingPinia-Returns}%
+#### Returns %{#Functions-createTestingPinia-Returns}%
[`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md)
"@vueuse/core": "^9.5.0",
"pinia": "workspace:^2.0.18",
"vitepress": "^1.0.0-0"
- }
+ },
+ "devDependencies": {}
}
(page) => {
if (page.url !== 'index.md' && page.contents) {
page.contents = prependYAML(page.contents, {
- sidebar: 'auto',
// TODO: figure out a way to point to the source files?
- editLinks: false,
- sidebarDepth: 3,
+ editLink: false,
})
}
titleStack.push(line.slice(level).trim())
currentLevel = level
- const slugifiedTitle = slugify(titleStack.join('-'))
+ // no need to add ids to h1
+ if (level < 2) continue
+
+ // ignore the root level (h1) to match the sidebar
+ const slugifiedTitle = slugify(titleStack.slice(1).join('-'))
let id
if (existingIds.has(slugifiedTitle)) {
const current = existingIds.get(slugifiedTitle)
projects / thirdparty / vuejs / pinia.git / commitdiff
