From: Eduardo San Martin Morote Date: Tue, 10 Jan 2023 22:55:44 +0000 (+0100) Subject: docs: fix ids X-Git-Tag: @pinia/nuxt@0.4.7~33 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1b4581ab15ca3bff397342dfa195023a8b66c148;p=thirdparty%2Fvuejs%2Fpinia.git docs: fix ids --- diff --git a/packages/docs-new/api/enums/pinia.MutationType.md b/packages/docs-new/api/enums/pinia.MutationType.md index 1654ed4d..031c580e 100644 --- a/packages/docs-new/api/enums/pinia.MutationType.md +++ b/packages/docs-new/api/enums/pinia.MutationType.md @@ -6,15 +6,15 @@ 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 Members %{#Enumeration:-MutationType-Enumeration-Members}% -### direct +### direct %{#Enumeration:-MutationType-Enumeration-Members-direct}% • **direct** = ``"direct"`` @@ -26,7 +26,7 @@ Direct mutation of the state: ___ -### patchFunction +### patchFunction %{#Enumeration:-MutationType-Enumeration-Members-patchFunction}% • **patchFunction** = ``"patch function"`` @@ -36,7 +36,7 @@ Mutated the state with `$patch` and a function ___ -### patchObject +### patchObject %{#Enumeration:-MutationType-Enumeration-Members-patchObject}% • **patchObject** = ``"patch object"`` diff --git a/packages/docs-new/api/index.md b/packages/docs-new/api/index.md index f25b0e46..3b28f10b 100644 --- a/packages/docs-new/api/index.md +++ b/packages/docs-new/api/index.md @@ -1,8 +1,8 @@ API Documentation -# API Documentation +# API Documentation %{#API-Documentation}% -## Modules +## Modules %{#API-Documentation-Modules}% - [@pinia/nuxt](modules/pinia_nuxt.md) - [@pinia/testing](modules/pinia_testing.md) diff --git a/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md index 7b5cbf10..56e17275 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineSetupStoreOptions -# Interface: DefineSetupStoreOptions +# Interface: DefineSetupStoreOptions %{#Interface:-DefineSetupStoreOptions}% [pinia](../modules/pinia.md).DefineSetupStoreOptions @@ -17,7 +17,7 @@ augment stores with the plugin API. [DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md). -## Type parameters +## Type parameters %{#Interface:-DefineSetupStoreOptions-Type-parameters}% | Name | Type | | :------ | :------ | @@ -26,15 +26,15 @@ augment stores with the plugin API. | `G` | `G` | | `A` | `A` | -## Hierarchy +## Hierarchy %{#Interface:-DefineSetupStoreOptions-Hierarchy}% - [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\> ↳ **`DefineSetupStoreOptions`** -## Properties +## Properties %{#Interface:-DefineSetupStoreOptions-Properties}% -### actions +### actions %{#Interface:-DefineSetupStoreOptions-Properties-actions}% • `Optional` **actions**: `A` diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md index 5cc1fa41..77a42daa 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptions -# Interface: DefineStoreOptions +# Interface: DefineStoreOptions %{#Interface:-DefineStoreOptions}% [pinia](../modules/pinia.md).DefineStoreOptions @@ -17,7 +17,7 @@ augment stores with the plugin API. [DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md). -## Type parameters +## Type parameters %{#Interface:-DefineStoreOptions-Type-parameters}% | Name | Type | | :------ | :------ | @@ -26,15 +26,15 @@ augment stores with the plugin API. | `G` | `G` | | `A` | `A` | -## Hierarchy +## Hierarchy %{#Interface:-DefineStoreOptions-Hierarchy}% - [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\> ↳ **`DefineStoreOptions`** -## Properties +## Properties %{#Interface:-DefineStoreOptions-Properties}% -### actions +### actions %{#Interface:-DefineStoreOptions-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)\>\> @@ -42,7 +42,7 @@ Optional object of actions. ___ -### getters +### getters %{#Interface:-DefineStoreOptions-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`\> @@ -50,7 +50,7 @@ Optional object of getters. ___ -### id +### id %{#Interface:-DefineStoreOptions-Properties-id}% • **id**: `Id` @@ -58,24 +58,24 @@ Unique string key to identify the store across the application. ___ -### state +### state %{#Interface:-DefineStoreOptions-Properties-state}% • `Optional` **state**: () => `S` -#### Type declaration +#### Type declaration %{#Interface:-DefineStoreOptions-Properties-state-Type-declaration}% ▸ (): `S` Function to create a fresh state. **Must be an arrow function** to ensure correct typings! -##### Returns +##### Returns %{#Interface:-DefineStoreOptions-Properties-state-Type-declaration-Returns}% `S` -## Methods +## Methods %{#Interface:-DefineStoreOptions-Methods}% -### hydrate +### hydrate %{#Interface:-DefineStoreOptions-Methods-hydrate}% ▸ `Optional` **hydrate**(`storeState`, `initialState`): `void` @@ -100,13 +100,13 @@ const useStore = defineStore('main', { }) ``` -#### Parameters +#### Parameters %{#Interface:-DefineStoreOptions-Methods-hydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### Returns +#### Returns %{#Interface:-DefineStoreOptions-Methods-hydrate-Returns}% `void` diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md index 7a319ed1..9f9e1784 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsBase -# Interface: DefineStoreOptionsBase +# Interface: DefineStoreOptionsBase %{#Interface:-DefineStoreOptionsBase}% [pinia](../modules/pinia.md).DefineStoreOptionsBase @@ -14,14 +14,14 @@ Options passed to `defineStore()` that are common between option and setup stores. Extend this interface if you want to add custom options to both kinds of stores. -## Type parameters +## Type parameters %{#Interface:-DefineStoreOptionsBase-Type-parameters}% | Name | Type | | :------ | :------ | | `S` | extends [`StateTree`](../modules/pinia.md#statetree) | | `Store` | `Store` | -## Hierarchy +## Hierarchy %{#Interface:-DefineStoreOptionsBase-Hierarchy}% - **`DefineStoreOptionsBase`** diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index 15777ac9..8dbd58eb 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsInPlugin -# Interface: DefineStoreOptionsInPlugin +# Interface: DefineStoreOptionsInPlugin %{#Interface:-DefineStoreOptionsInPlugin}% [pinia](../modules/pinia.md).DefineStoreOptionsInPlugin Available `options` when creating a pinia plugin. -## Type parameters +## Type parameters %{#Interface:-DefineStoreOptionsInPlugin-Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,15 +21,15 @@ Available `options` when creating a pinia plugin. | `G` | `G` | | `A` | `A` | -## Hierarchy +## Hierarchy %{#Interface:-DefineStoreOptionsInPlugin-Hierarchy}% - `Omit`<[`DefineStoreOptions`](pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\>, ``"id"`` \| ``"actions"``\> ↳ **`DefineStoreOptionsInPlugin`** -## Properties +## Properties %{#Interface:-DefineStoreOptionsInPlugin-Properties}% -### actions +### actions %{#Interface:-DefineStoreOptionsInPlugin-Properties-actions}% • **actions**: `A` @@ -39,40 +39,40 @@ Defaults to an empty object if no actions are defined. ___ -### getters +### getters %{#Interface:-DefineStoreOptionsInPlugin-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 +#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Properties-getters-Inherited-from}% Omit.getters ___ -### state +### state %{#Interface:-DefineStoreOptionsInPlugin-Properties-state}% • `Optional` **state**: () => `S` -#### Type declaration +#### Type declaration %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Type-declaration}% ▸ (): `S` Function to create a fresh state. **Must be an arrow function** to ensure correct typings! -##### Returns +##### Returns %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Type-declaration-Returns}% `S` -#### Inherited from +#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Inherited-from}% Omit.state -## Methods +## Methods %{#Interface:-DefineStoreOptionsInPlugin-Methods}% -### hydrate +### hydrate %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate}% ▸ `Optional` **hydrate**(`storeState`, `initialState`): `void` @@ -97,17 +97,17 @@ const useStore = defineStore('main', { }) ``` -#### Parameters +#### Parameters %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### Returns +#### Returns %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Returns}% `void` -#### Inherited from +#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Inherited-from}% Omit.hydrate diff --git a/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md b/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md index 7271366a..53fbfecc 100644 --- a/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md +++ b/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MapStoresCustomization -# Interface: MapStoresCustomization +# Interface: MapStoresCustomization %{#Interface:-MapStoresCustomization}% [pinia](../modules/pinia.md).MapStoresCustomization diff --git a/packages/docs-new/api/interfaces/pinia.Pinia.md b/packages/docs-new/api/interfaces/pinia.Pinia.md index 9c88b0ca..79a2ba58 100644 --- a/packages/docs-new/api/interfaces/pinia.Pinia.md +++ b/packages/docs-new/api/interfaces/pinia.Pinia.md @@ -6,60 +6,60 @@ 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 +## Hierarchy %{#Interface:-Pinia-Hierarchy}% - **`Pinia`** ↳ [`TestingPinia`](pinia_testing.TestingPinia.md) -## Properties +## Properties %{#Interface:-Pinia-Properties}% -### install +### install %{#Interface:-Pinia-Properties-install}% • **install**: (`app`: `App`<`any`\>) => `void` -#### Type declaration +#### Type declaration %{#Interface:-Pinia-Properties-install-Type-declaration}% ▸ (`app`): `void` -##### Parameters +##### Parameters %{#Interface:-Pinia-Properties-install-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `app` | `App`<`any`\> | -##### Returns +##### Returns %{#Interface:-Pinia-Properties-install-Type-declaration-Returns}% `void` ___ -### state +### state %{#Interface:-Pinia-Properties-state}% • **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\> root state -## Methods +## Methods %{#Interface:-Pinia-Methods}% -### use +### use %{#Interface:-Pinia-Methods-use}% ▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md) Adds a store plugin to extend every store -#### Parameters +#### Parameters %{#Interface:-Pinia-Methods-use-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### Returns +#### Returns %{#Interface:-Pinia-Methods-use-Returns}% [`Pinia`](pinia.Pinia.md) diff --git a/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md index 46c96d5e..76979fe3 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomProperties -# Interface: PiniaCustomProperties +# Interface: PiniaCustomProperties %{#Interface:-PiniaCustomProperties}% [pinia](../modules/pinia.md).PiniaCustomProperties Interface to be extended by the user when they add properties through plugins. -## Type parameters +## Type parameters %{#Interface:-PiniaCustomProperties-Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,24 +21,24 @@ Interface to be extended by the user when they add properties through plugins. | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Accessors +## Accessors %{#Interface:-PiniaCustomProperties-Accessors}% -### route +### route %{#Interface:-PiniaCustomProperties-Accessors-route}% • `get` **route**(): `RouteLocationNormalized` -#### Returns +#### Returns %{#Interface:-PiniaCustomProperties-Accessors-route-Returns}% `RouteLocationNormalized` • `set` **route**(`value`): `void` -#### Parameters +#### Parameters %{#Interface:-PiniaCustomProperties-Accessors-route-Parameters}% | Name | Type | | :------ | :------ | | `value` | `RouteLocationNormalizedLoaded` \| `Ref`<`RouteLocationNormalizedLoaded`\> | -#### Returns +#### Returns %{#Interface:-PiniaCustomProperties-Accessors-route-Returns_1}% `void` diff --git a/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md b/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md index adc85330..4c79e446 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomStateProperties -# Interface: PiniaCustomStateProperties +# Interface: PiniaCustomStateProperties %{#Interface:-PiniaCustomStateProperties}% [pinia](../modules/pinia.md).PiniaCustomStateProperties Properties that are added to every `store.$state` by `pinia.use()`. -## Type parameters +## Type parameters %{#Interface:-PiniaCustomStateProperties-Type-parameters}% | Name | Type | | :------ | :------ | diff --git a/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md b/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md index a7454493..af272b08 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md @@ -6,25 +6,25 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPlugin -# Interface: PiniaPlugin +# Interface: PiniaPlugin %{#Interface:-PiniaPlugin}% [pinia](../modules/pinia.md).PiniaPlugin -## Callable +## Callable %{#Interface:-PiniaPlugin-Callable}% -### PiniaPlugin +### PiniaPlugin %{#Interface:-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 +#### Parameters %{#Interface:-PiniaPlugin-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 +#### Returns %{#Interface:-PiniaPlugin-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)\>\> diff --git a/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md index 84c07ed3..abfe2f67 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPluginContext -# Interface: PiniaPluginContext +# Interface: PiniaPluginContext %{#Interface:-PiniaPluginContext}% [pinia](../modules/pinia.md).PiniaPluginContext Context argument passed to Pinia plugins. -## Type parameters +## Type parameters %{#Interface:-PiniaPluginContext-Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,9 +21,9 @@ Context argument passed to Pinia plugins. | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Properties +## Properties %{#Interface:-PiniaPluginContext-Properties}% -### app +### app %{#Interface:-PiniaPluginContext-Properties-app}% • **app**: `App`<`any`\> @@ -31,7 +31,7 @@ Current app created with `Vue.createApp()`. ___ -### options +### options %{#Interface:-PiniaPluginContext-Properties-options}% • **options**: [`DefineStoreOptionsInPlugin`](pinia.DefineStoreOptionsInPlugin.md)<`Id`, `S`, `G`, `A`\> @@ -39,7 +39,7 @@ Initial options defining the store when calling `defineStore()`. ___ -### pinia +### pinia %{#Interface:-PiniaPluginContext-Properties-pinia}% • **pinia**: [`Pinia`](pinia.Pinia.md) @@ -47,7 +47,7 @@ pinia instance. ___ -### store +### store %{#Interface:-PiniaPluginContext-Properties-store}% • **store**: [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> diff --git a/packages/docs-new/api/interfaces/pinia.StoreDefinition.md b/packages/docs-new/api/interfaces/pinia.StoreDefinition.md index 9288199f..8d98e624 100644 --- a/packages/docs-new/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs-new/api/interfaces/pinia.StoreDefinition.md @@ -6,11 +6,11 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreDefinition -# Interface: StoreDefinition +# Interface: StoreDefinition %{#Interface:-StoreDefinition}% [pinia](../modules/pinia.md).StoreDefinition -## Type parameters +## Type parameters %{#Interface:-StoreDefinition-Type-parameters}% | Name | Type | | :------ | :------ | @@ -19,28 +19,28 @@ sidebarDepth: 3 | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Callable +## Callable %{#Interface:-StoreDefinition-Callable}% -### StoreDefinition +### StoreDefinition %{#Interface:-StoreDefinition-Callable-StoreDefinition}% ▸ **StoreDefinition**(`pinia?`, `hot?`): [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> Returns a store, creates it if necessary. -#### Parameters +#### Parameters %{#Interface:-StoreDefinition-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 +#### Returns %{#Interface:-StoreDefinition-Callable-StoreDefinition-Returns}% [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> -## Properties +## Properties %{#Interface:-StoreDefinition-Properties}% -### $id +### $id %{#Interface:-StoreDefinition-Properties-$id}% • **$id**: `Id` diff --git a/packages/docs-new/api/interfaces/pinia.StoreProperties.md b/packages/docs-new/api/interfaces/pinia.StoreProperties.md index 416136de..42a1f6ab 100644 --- a/packages/docs-new/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs-new/api/interfaces/pinia.StoreProperties.md @@ -6,27 +6,27 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreProperties -# Interface: StoreProperties +# Interface: StoreProperties %{#Interface:-StoreProperties}% [pinia](../modules/pinia.md).StoreProperties Properties of a store. -## Type parameters +## Type parameters %{#Interface:-StoreProperties-Type-parameters}% | Name | Type | | :------ | :------ | | `Id` | extends `string` | -## Hierarchy +## Hierarchy %{#Interface:-StoreProperties-Hierarchy}% - **`StoreProperties`** ↳ [`_StoreWithState`](pinia._StoreWithState.md) -## Properties +## Properties %{#Interface:-StoreProperties-Properties}% -### $id +### $id %{#Interface:-StoreProperties-Properties-$id}% • **$id**: `Id` @@ -34,7 +34,7 @@ Unique identifier of the store ___ -### \_customProperties +### \_customProperties %{#Interface:-StoreProperties-Properties-\_customProperties}% • **\_customProperties**: `Set`<`string`\> diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index e73d9329..0045422e 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationDirect -# Interface: SubscriptionCallbackMutationDirect +# Interface: SubscriptionCallbackMutationDirect %{#Interface:-SubscriptionCallbackMutationDirect}% [pinia](../modules/pinia.md).SubscriptionCallbackMutationDirect @@ -14,15 +14,15 @@ Context passed to a subscription callback when directly mutating the state of a store with `store.someState = newValue` or `store.$state.someState = newValue`. -## Hierarchy +## Hierarchy %{#Interface:-SubscriptionCallbackMutationDirect-Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationDirect`** -## Properties +## Properties %{#Interface:-SubscriptionCallbackMutationDirect-Properties}% -### events +### events %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events}% • **events**: `DebuggerEvent` @@ -30,30 +30,30 @@ newValue`. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### storeId +### storeId %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from +#### Inherited from %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type +### type %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type}% • **type**: [`direct`](../enums/pinia.MutationType.md#direct) Type of the mutation. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index b70a236b..833e34f1 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -6,22 +6,22 @@ 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 +## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchFunction-Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationPatchFunction`** -## Properties +## Properties %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties}% -### events +### events %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events}% • **events**: `DebuggerEvent`[] @@ -29,30 +29,30 @@ with a function. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### storeId +### storeId %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from +#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type +### type %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type}% • **type**: [`patchFunction`](../enums/pinia.MutationType.md#patchfunction) Type of the mutation. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index 37685c90..37324bac 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -6,28 +6,28 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchObject -# Interface: SubscriptionCallbackMutationPatchObject +# Interface: SubscriptionCallbackMutationPatchObject %{#Interface:-SubscriptionCallbackMutationPatchObject}% [pinia](../modules/pinia.md).SubscriptionCallbackMutationPatchObject Context passed to a subscription callback when `store.$patch()` is called with an object. -## Type parameters +## Type parameters %{#Interface:-SubscriptionCallbackMutationPatchObject-Type-parameters}% | Name | | :------ | | `S` | -## Hierarchy +## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchObject-Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationPatchObject`** -## Properties +## Properties %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties}% -### events +### events %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-events}% • **events**: `DebuggerEvent`[] @@ -35,13 +35,13 @@ with an object. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### payload +### payload %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-payload}% • **payload**: [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`S`\> @@ -49,24 +49,24 @@ Object passed to `store.$patch()`. ___ -### storeId +### storeId %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from +#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type +### type %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-type}% • **type**: [`patchObject`](../enums/pinia.MutationType.md#patchobject) Type of the mutation. -#### Overrides +#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md b/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md index 119db171..41abc59a 100644 --- a/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md +++ b/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md @@ -6,7 +6,7 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext -# Interface: \_StoreOnActionListenerContext +# Interface: \_StoreOnActionListenerContext %{#Interface:-\_StoreOnActionListenerContext}% [pinia](../modules/pinia.md)._StoreOnActionListenerContext @@ -14,7 +14,7 @@ Actual type for [StoreOnActionListenerContext](../modules/pinia.md#storeonaction purposes. For internal use only. For internal use **only** -## Type parameters +## Type parameters %{#Interface:-\_StoreOnActionListenerContext-Type-parameters}% | Name | Type | | :------ | :------ | @@ -22,32 +22,32 @@ For internal use **only** | `ActionName` | extends `string` | | `A` | `A` | -## Properties +## Properties %{#Interface:-\_StoreOnActionListenerContext-Properties}% -### after +### after %{#Interface:-\_StoreOnActionListenerContext-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 +#### Type declaration %{#Interface:-\_StoreOnActionListenerContext-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 +##### Parameters %{#Interface:-\_StoreOnActionListenerContext-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 +##### Returns %{#Interface:-\_StoreOnActionListenerContext-Properties-after-Type-declaration-Returns}% `void` ___ -### args +### args %{#Interface:-\_StoreOnActionListenerContext-Properties-args}% • **args**: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? `Parameters`<`A`[`ActionName`]\> : `unknown`[] @@ -55,7 +55,7 @@ Parameters passed to the action ___ -### name +### name %{#Interface:-\_StoreOnActionListenerContext-Properties-name}% • **name**: `ActionName` @@ -63,30 +63,30 @@ Name of the action ___ -### onError +### onError %{#Interface:-\_StoreOnActionListenerContext-Properties-onError}% • **onError**: (`callback`: (`error`: `unknown`) => `void`) => `void` -#### Type declaration +#### Type declaration %{#Interface:-\_StoreOnActionListenerContext-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 +##### Parameters %{#Interface:-\_StoreOnActionListenerContext-Properties-onError-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `callback` | (`error`: `unknown`) => `void` | -##### Returns +##### Returns %{#Interface:-\_StoreOnActionListenerContext-Properties-onError-Type-declaration-Returns}% `void` ___ -### store +### store %{#Interface:-\_StoreOnActionListenerContext-Properties-store}% • **store**: `Store` diff --git a/packages/docs-new/api/interfaces/pinia._StoreWithState.md b/packages/docs-new/api/interfaces/pinia._StoreWithState.md index 3cd030b4..e320bb43 100644 --- a/packages/docs-new/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs-new/api/interfaces/pinia._StoreWithState.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreWithState -# Interface: \_StoreWithState +# Interface: \_StoreWithState %{#Interface:-\_StoreWithState}% [pinia](../modules/pinia.md)._StoreWithState Base store with state and functions. Should not be used directly. -## Type parameters +## Type parameters %{#Interface:-\_StoreWithState-Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,27 +21,27 @@ Base store with state and functions. Should not be used directly. | `G` | `G` | | `A` | `A` | -## Hierarchy +## Hierarchy %{#Interface:-\_StoreWithState-Hierarchy}% - [`StoreProperties`](pinia.StoreProperties.md)<`Id`\> ↳ **`_StoreWithState`** -## Properties +## Properties %{#Interface:-\_StoreWithState-Properties}% -### $id +### $id %{#Interface:-\_StoreWithState-Properties-$id}% • **$id**: `Id` Unique identifier of the store -#### Inherited from +#### Inherited from %{#Interface:-\_StoreWithState-Properties-$id-Inherited-from}% [StoreProperties](pinia.StoreProperties.md).[$id](pinia.StoreProperties.md#$id) ___ -### $state +### $state %{#Interface:-\_StoreWithState-Properties-$state}% • **$state**: `UnwrapRef`<`S`\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<`S`\> @@ -49,7 +49,7 @@ State of the Store. Setting it will replace the whole state. ___ -### \_customProperties +### \_customProperties %{#Interface:-\_StoreWithState-Properties-\_customProperties}% • **\_customProperties**: `Set`<`string`\> @@ -57,27 +57,30 @@ Used by devtools plugin to retrieve properties added with plugins. Removed in production. Can be used by the user to add property keys of the store that should be displayed in devtools. -#### Inherited from +#### Inherited from %{#Interface:-\_StoreWithState-Properties-\_customProperties-Inherited-from}% [StoreProperties](pinia.StoreProperties.md).[_customProperties](pinia.StoreProperties.md#_customproperties) -## Methods +## Methods %{#Interface:-\_StoreWithState-Methods}% -### $dispose +### $dispose %{#Interface:-\_StoreWithState-Methods-$dispose}% ▸ **$dispose**(): `void` Stops the associated effect scope of the store and remove it from the store registry. Plugins can override this method to cleanup any added effects. e.g. devtools plugin stops displaying disposed stores from devtools. +Note this doesn't delete the state of the store, you have to do it manually with +`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 +#### Returns %{#Interface:-\_StoreWithState-Methods-$dispose-Returns}% `void` ___ -### $onAction +### $onAction %{#Interface:-\_StoreWithState-Methods-$onAction}% ▸ **$onAction**(`callback`, `detached?`): () => `void` @@ -112,14 +115,14 @@ store.$onAction(({ after, onError }) => { }) ``` -#### Parameters +#### Parameters %{#Interface:-\_StoreWithState-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 +#### Returns %{#Interface:-\_StoreWithState-Methods-$onAction-Returns}% `fn` @@ -158,7 +161,7 @@ store.$onAction(({ after, onError }) => { }) ``` -##### Returns +##### Returns %{#Interface:-\_StoreWithState-Methods-$onAction-Returns-Returns}% `void` @@ -166,19 +169,19 @@ function that removes the watcher ___ -### $patch +### $patch %{#Interface:-\_StoreWithState-Methods-$patch}% ▸ **$patch**(`partialState`): `void` Applies a state patch to current state. Allows passing nested values -#### Parameters +#### Parameters %{#Interface:-\_StoreWithState-Methods-$patch-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `partialState` | [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`UnwrapRef`<`S`\>\> | patch to apply to the state | -#### Returns +#### Returns %{#Interface:-\_StoreWithState-Methods-$patch-Returns}% `void` @@ -188,38 +191,38 @@ Group multiple changes into one function. Useful when mutating objects like 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 +#### Type parameters %{#Interface:-\_StoreWithState-Methods-$patch-Type-parameters}% | Name | Type | | :------ | :------ | | `F` | extends (`state`: `UnwrapRef`<`S`\>) => `any` | -#### Parameters +#### Parameters %{#Interface:-\_StoreWithState-Methods-$patch-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `stateMutator` | `ReturnType`<`F`\> extends `Promise`<`any`\> ? `never` : `F` | function that mutates `state`, cannot be async | -#### Returns +#### Returns %{#Interface:-\_StoreWithState-Methods-$patch-Returns_1}% `void` ___ -### $reset +### $reset %{#Interface:-\_StoreWithState-Methods-$reset}% ▸ **$reset**(): `void` Resets the store to its initial state by building a new state object. TODO: make this options only -#### Returns +#### Returns %{#Interface:-\_StoreWithState-Methods-$reset-Returns}% `void` ___ -### $subscribe +### $subscribe %{#Interface:-\_StoreWithState-Methods-$subscribe}% ▸ **$subscribe**(`callback`, `options?`): () => `void` @@ -227,14 +230,14 @@ Setups a callback to be called whenever the state changes. It also returns a fun 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 +#### Parameters %{#Interface:-\_StoreWithState-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 +#### Returns %{#Interface:-\_StoreWithState-Methods-$subscribe-Returns}% `fn` @@ -246,7 +249,7 @@ Setups a callback to be called whenever the state changes. It also returns a fun 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 +##### Returns %{#Interface:-\_StoreWithState-Methods-$subscribe-Returns-Returns}% `void` diff --git a/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index e127b13e..5f1db675 100644 --- a/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -6,13 +6,13 @@ 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 +## Hierarchy %{#Interface:-\_SubscriptionCallbackMutationBase-Hierarchy}% - **`_SubscriptionCallbackMutationBase`** @@ -22,9 +22,9 @@ Base type for the context passed to a subscription callback. Internal type. ↳ [`SubscriptionCallbackMutationPatchObject`](pinia.SubscriptionCallbackMutationPatchObject.md) -## Properties +## Properties %{#Interface:-\_SubscriptionCallbackMutationBase-Properties}% -### events +### events %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-events}% • `Optional` **events**: `DebuggerEvent` \| `DebuggerEvent`[] @@ -34,7 +34,7 @@ devtools and plugins **during development only**. ___ -### storeId +### storeId %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-storeId}% • **storeId**: `string` @@ -42,7 +42,7 @@ ___ ___ -### type +### type %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-type}% • **type**: [`MutationType`](../enums/pinia.MutationType.md) diff --git a/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md b/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md index 0cf62ca8..c9c08503 100644 --- a/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md +++ b/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md @@ -6,13 +6,13 @@ 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 +## Properties %{#Interface:-ModuleOptions-Properties}% -### autoImports +### autoImports %{#Interface:-ModuleOptions-Properties-autoImports}% • `Optional` **autoImports**: (`string` \| [`string`, `string`])[] @@ -31,7 +31,7 @@ autoImports: [ ___ -### disableVuex +### disableVuex %{#Interface:-ModuleOptions-Properties-disableVuex}% • `Optional` **disableVuex**: `boolean` diff --git a/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md index 8c77dcba..801b875b 100644 --- a/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md @@ -6,48 +6,48 @@ 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 +## Properties %{#Interface:-TestingOptions-Properties}% -### createSpy +### createSpy %{#Interface:-TestingOptions-Properties-createSpy}% • `Optional` **createSpy**: (`fn?`: (...`args`: `any`[]) => `any`) => (...`args`: `any`[]) => `any` -#### Type declaration +#### Type declaration %{#Interface:-TestingOptions-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 +##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `fn?` | (...`args`: `any`[]) => `any` | -##### Returns +##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns}% `fn` ▸ (...`args`): `any` -##### Parameters +##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters_1}% | Name | Type | | :------ | :------ | | `...args` | `any`[] | -##### Returns +##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns_1}% `any` ___ -### fakeApp +### fakeApp %{#Interface:-TestingOptions-Properties-fakeApp}% • `Optional` **fakeApp**: `boolean` @@ -58,7 +58,7 @@ Defaults to false. ___ -### initialState +### initialState %{#Interface:-TestingOptions-Properties-initialState}% • `Optional` **initialState**: [`StateTree`](../modules/pinia.md#statetree) @@ -67,7 +67,7 @@ allowing you to only set a few properties that are required in your test. ___ -### plugins +### plugins %{#Interface:-TestingOptions-Properties-plugins}% • `Optional` **plugins**: [`PiniaPlugin`](pinia.PiniaPlugin.md)[] @@ -76,7 +76,7 @@ your application that will be used while testing. ___ -### stubActions +### stubActions %{#Interface:-TestingOptions-Properties-stubActions}% • `Optional` **stubActions**: `boolean` @@ -88,7 +88,7 @@ handle this in `createSpy()`. ___ -### stubPatch +### stubPatch %{#Interface:-TestingOptions-Properties-stubPatch}% • `Optional` **stubPatch**: `boolean` diff --git a/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md index 670c97d1..ac833ab0 100644 --- a/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md @@ -6,22 +6,22 @@ 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 +## Hierarchy %{#Interface:-TestingPinia-Hierarchy}% - [`Pinia`](pinia.Pinia.md) ↳ **`TestingPinia`** -## Properties +## Properties %{#Interface:-TestingPinia-Properties}% -### app +### app %{#Interface:-TestingPinia-Properties-app}% • **app**: `App`<`any`\> @@ -29,58 +29,58 @@ App used by Pinia ___ -### install +### install %{#Interface:-TestingPinia-Properties-install}% • **install**: (`app`: `App`<`any`\>) => `void` -#### Type declaration +#### Type declaration %{#Interface:-TestingPinia-Properties-install-Type-declaration}% ▸ (`app`): `void` -##### Parameters +##### Parameters %{#Interface:-TestingPinia-Properties-install-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `app` | `App`<`any`\> | -##### Returns +##### Returns %{#Interface:-TestingPinia-Properties-install-Type-declaration-Returns}% `void` -#### Inherited from +#### Inherited from %{#Interface:-TestingPinia-Properties-install-Inherited-from}% [Pinia](pinia.Pinia.md).[install](pinia.Pinia.md#install) ___ -### state +### state %{#Interface:-TestingPinia-Properties-state}% • **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\> root state -#### Inherited from +#### Inherited from %{#Interface:-TestingPinia-Properties-state-Inherited-from}% [Pinia](pinia.Pinia.md).[state](pinia.Pinia.md#state) -## Methods +## Methods %{#Interface:-TestingPinia-Methods}% -### use +### use %{#Interface:-TestingPinia-Methods-use}% ▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md) Adds a store plugin to extend every store -#### Parameters +#### Parameters %{#Interface:-TestingPinia-Methods-use-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### Returns +#### Returns %{#Interface:-TestingPinia-Methods-use-Returns}% [`Pinia`](pinia.Pinia.md) -#### Inherited from +#### Inherited from %{#Interface:-TestingPinia-Methods-use-Inherited-from}% [Pinia](pinia.Pinia.md).[use](pinia.Pinia.md#use) diff --git a/packages/docs-new/api/modules/pinia.md b/packages/docs-new/api/modules/pinia.md index e1ec6d36..d351fd15 100644 --- a/packages/docs-new/api/modules/pinia.md +++ b/packages/docs-new/api/modules/pinia.md @@ -6,13 +6,13 @@ sidebarDepth: 3 [API Documentation](../index.md) / pinia -# Module: pinia +# Module: pinia %{#Module:-pinia}% -## Enumerations +## Enumerations %{#Module:-pinia-Enumerations}% - [MutationType](../enums/pinia.MutationType.md) -## Interfaces +## Interfaces %{#Module:-pinia-Interfaces}% - [DefineSetupStoreOptions](../interfaces/pinia.DefineSetupStoreOptions.md) - [DefineStoreOptions](../interfaces/pinia.DefineStoreOptions.md) @@ -33,9 +33,9 @@ sidebarDepth: 3 - [\_StoreWithState](../interfaces/pinia._StoreWithState.md) - [\_SubscriptionCallbackMutationBase](../interfaces/pinia._SubscriptionCallbackMutationBase.md) -## Type Aliases +## Type Aliases %{#Module:-pinia-Type-Aliases}% -### PiniaStorePlugin +### PiniaStorePlugin %{#Module:-pinia-Type-Aliases-PiniaStorePlugin}% Ƭ **PiniaStorePlugin**: [`PiniaPlugin`](../interfaces/pinia.PiniaPlugin.md) @@ -47,7 +47,7 @@ use PiniaPlugin instead ___ -### StateTree +### StateTree %{#Module:-pinia-Type-Aliases-StateTree}% Ƭ **StateTree**: `Record`<`string` \| `number` \| `symbol`, `any`\> @@ -55,13 +55,13 @@ Generic state of a Store ___ -### Store +### Store %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-Store-Type-parameters}% | Name | Type | | :------ | :------ | @@ -72,14 +72,14 @@ Store type to build a store. ___ -### StoreActions +### StoreActions %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-StoreActions-Type-parameters}% | Name | | :------ | @@ -87,7 +87,7 @@ Options Store. ___ -### StoreGeneric +### StoreGeneric %{#Module:-pinia-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)\> @@ -97,14 +97,14 @@ about the kind of store that is passed. ___ -### StoreGetters +### StoreGetters %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-StoreGetters-Type-parameters}% | Name | | :------ | @@ -112,11 +112,11 @@ Options Store. ___ -### StoreOnActionListener +### StoreOnActionListener %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-parameters}% | Name | Type | | :------ | :------ | @@ -125,32 +125,32 @@ ___ | `G` | `G` | | `A` | `A` | -#### Type declaration +#### Type declaration %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration}% ▸ (`context`): `void` Argument of `store.$onAction()` -##### Parameters +##### Parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\> | -##### Returns +##### Returns %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Returns}% `void` ___ -### StoreOnActionListenerContext +### StoreOnActionListenerContext %{#Module:-pinia-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, 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 +#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListenerContext-Type-parameters}% | Name | Type | | :------ | :------ | @@ -161,14 +161,14 @@ TODO: should have only the Id, the Store and Actions to generate the proper obje ___ -### StoreState +### StoreState %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-StoreState-Type-parameters}% | Name | | :------ | @@ -176,42 +176,42 @@ Options Store. Note this unwraps refs. ___ -### SubscriptionCallback +### SubscriptionCallback %{#Module:-pinia-Type-Aliases-SubscriptionCallback}% Ƭ **SubscriptionCallback**<`S`\>: (`mutation`: [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\>, `state`: `UnwrapRef`<`S`\>) => `void` -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-parameters}% | Name | | :------ | | `S` | -#### Type declaration +#### Type declaration %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration}% ▸ (`mutation`, `state`): `void` Callback of a subscription -##### Parameters +##### Parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `mutation` | [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\> | | `state` | `UnwrapRef`<`S`\> | -##### Returns +##### Returns %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Returns}% `void` ___ -### SubscriptionCallbackMutation +### SubscriptionCallbackMutation %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallbackMutation-Type-parameters}% | Name | | :------ | @@ -219,7 +219,7 @@ Context object passed to a subscription callback. ___ -### \_ActionsTree +### \_ActionsTree %{#Module:-pinia-Type-Aliases-\_ActionsTree}% Ƭ **\_ActionsTree**: `Record`<`string`, [`_Method`](pinia.md#_method)\> @@ -228,11 +228,11 @@ For internal use **only** ___ -### \_Awaited +### \_Awaited %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_Awaited-Type-parameters}% | Name | | :------ | @@ -240,7 +240,7 @@ ___ ___ -### \_DeepPartial +### \_DeepPartial %{#Module:-pinia-Type-Aliases-\_DeepPartial}% Ƭ **\_DeepPartial**<`T`\>: { [K in keyof T]?: \_DeepPartial } @@ -248,7 +248,7 @@ Recursive `Partial`. Used by [['$patch']](pinia.md#store). For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_DeepPartial-Type-parameters}% | Name | | :------ | @@ -256,13 +256,13 @@ For internal use **only** ___ -### \_ExtractActionsFromSetupStore +### \_ExtractActionsFromSetupStore %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore-Type-parameters}% | Name | | :------ | @@ -270,14 +270,14 @@ For internal use **only** ___ -### \_ExtractActionsFromSetupStore\_Keys +### \_ExtractActionsFromSetupStore\_Keys %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -285,13 +285,13 @@ For internal use **only** ___ -### \_ExtractGettersFromSetupStore +### \_ExtractGettersFromSetupStore %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore-Type-parameters}% | Name | | :------ | @@ -299,14 +299,14 @@ For internal use **only** ___ -### \_ExtractGettersFromSetupStore\_Keys +### \_ExtractGettersFromSetupStore\_Keys %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -314,13 +314,13 @@ For internal use **only** ___ -### \_ExtractStateFromSetupStore +### \_ExtractStateFromSetupStore %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore-Type-parameters}% | Name | | :------ | @@ -328,14 +328,14 @@ For internal use **only** ___ -### \_ExtractStateFromSetupStore\_Keys +### \_ExtractStateFromSetupStore\_Keys %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -343,14 +343,14 @@ For internal use **only** ___ -### \_GettersTree +### \_GettersTree %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_GettersTree-Type-parameters}% | Name | Type | | :------ | :------ | @@ -358,13 +358,13 @@ For internal use **only** ___ -### \_MapActionsObjectReturn +### \_MapActionsObjectReturn %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn}% Ƭ **\_MapActionsObjectReturn**<`A`, `T`\>: { [key in keyof T]: A[T[key]] } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -373,13 +373,13 @@ For internal use **only** ___ -### \_MapActionsReturn +### \_MapActionsReturn %{#Module:-pinia-Type-Aliases-\_MapActionsReturn}% Ƭ **\_MapActionsReturn**<`A`\>: { [key in keyof A]: A[key] } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsReturn-Type-parameters}% | Name | | :------ | @@ -387,13 +387,13 @@ For internal use **only** ___ -### \_MapStateObjectReturn +### \_MapStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn}% Ƭ **\_MapStateObjectReturn**<`Id`, `S`, `G`, `A`, `T`\>: { [key in keyof T]: Function } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -405,13 +405,13 @@ For internal use **only** ___ -### \_MapStateReturn +### \_MapStateReturn %{#Module:-pinia-Type-Aliases-\_MapStateReturn}% Ƭ **\_MapStateReturn**<`S`, `G`, `Keys`\>: { [key in Keys]: Function } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -421,13 +421,13 @@ For internal use **only** ___ -### \_MapWritableStateObjectReturn +### \_MapWritableStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn}% Ƭ **\_MapWritableStateObjectReturn**<`S`, `T`\>: { [key in keyof T]: Object } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -436,13 +436,13 @@ For internal use **only** ___ -### \_MapWritableStateReturn +### \_MapWritableStateReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn}% Ƭ **\_MapWritableStateReturn**<`S`\>: { [key in keyof S]: Object } For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -450,11 +450,11 @@ For internal use **only** ___ -### \_Method +### \_Method %{#Module:-pinia-Type-Aliases-\_Method}% Ƭ **\_Method**: (...`args`: `any`[]) => `any` -#### Type declaration +#### Type declaration %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration}% ▸ (...`args`): `any` @@ -462,25 +462,25 @@ Generic type for a function that can infer arguments and return type For internal use **only** -##### Parameters +##### Parameters %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `...args` | `any`[] | -##### Returns +##### Returns %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Returns}% `any` ___ -### \_Spread +### \_Spread %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_Spread-Type-parameters}% | Name | Type | | :------ | :------ | @@ -488,13 +488,13 @@ For internal use **only**. ___ -### \_StoreObject +### \_StoreObject %{#Module:-pinia-Type-Aliases-\_StoreObject}% -Ƭ **\_StoreObject**<`S`\>: `S` extends [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md) ? { [Id in \`${Ids}${MapStoresCustomization extends Record<"suffix", infer Suffix extends string\> ? Suffix : "Store"}\`]: Function } : {} +Ƭ **\_StoreObject**<`S`\>: `S` extends [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md) ? { [Id in \`${Ids}${MapStoresCustomization extends Record<"suffix", infer Suffix\> ? Suffix : "Store"}\`]: Function } : {} For internal use **only**. -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreObject-Type-parameters}% | Name | | :------ | @@ -502,14 +502,14 @@ For internal use **only**. ___ -### \_StoreWithActions +### \_StoreWithActions %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithActions-Type-parameters}% | Name | | :------ | @@ -517,14 +517,14 @@ For internal use **only** ___ -### \_StoreWithGetters +### \_StoreWithGetters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters}% Ƭ **\_StoreWithGetters**<`G`\>: { readonly [k in keyof G]: G[k] extends Function ? R : UnwrapRef } Store augmented with getters. For internal usage only. For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters-Type-parameters}% | Name | | :------ | @@ -532,22 +532,22 @@ For internal use **only** ___ -### \_UnwrapAll +### \_UnwrapAll %{#Module:-pinia-Type-Aliases-\_UnwrapAll}% Ƭ **\_UnwrapAll**<`SS`\>: { [K in keyof SS]: UnwrapRef } Type that enables refactoring through IDE. For internal use **only** -#### Type parameters +#### Type parameters %{#Module:-pinia-Type-Aliases-\_UnwrapAll-Type-parameters}% | Name | | :------ | | `SS` | -## Variables +## Variables %{#Module:-pinia-Variables}% -### PiniaVuePlugin +### PiniaVuePlugin %{#Module:-pinia-Variables-PiniaVuePlugin}% • `Const` **PiniaVuePlugin**: `Plugin` @@ -575,9 +575,9 @@ new Vue({ `Vue` imported from 'vue'. -## Functions +## Functions %{#Module:-pinia-Functions}% -### acceptHMRUpdate +### acceptHMRUpdate %{#Module:-pinia-Functions-acceptHMRUpdate}% ▸ **acceptHMRUpdate**(`initialUseStore`, `hot`): (`newModule`: `any`) => `any` @@ -592,50 +592,50 @@ if (import.meta.hot) { } ``` -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns}% `fn` ▸ (`newModule`): `any` -##### Parameters +##### Parameters %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Parameters}% | Name | Type | | :------ | :------ | | `newModule` | `any` | -##### Returns +##### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Returns}% `any` ___ -### createPinia +### createPinia %{#Module:-pinia-Functions-createPinia}% ▸ **createPinia**(): [`Pinia`](../interfaces/pinia.Pinia.md) Creates a Pinia instance to be used by the application -#### Returns +#### Returns %{#Module:-pinia-Functions-createPinia-Returns}% [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### defineStore +### defineStore %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters}% | Name | Type | | :------ | :------ | @@ -644,14 +644,14 @@ Creates a `useStore` function that retrieves the store instance | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | | `A` | {} | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-defineStore-Returns}% [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -659,7 +659,7 @@ Creates a `useStore` function that retrieves the store instance Creates a `useStore` function that retrieves the store instance -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -668,13 +668,13 @@ Creates a `useStore` function that retrieves the store instance | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | | `A` | {} | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `options` | [`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\> | options to define the store | -#### Returns +#### Returns %{#Module:-pinia-Functions-defineStore-Returns_1}% [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -682,14 +682,14 @@ Creates a `useStore` function that retrieves the store instance Creates a `useStore` function that retrieves the store instance -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_2}% | Name | Type | | :------ | :------ | | `Id` | extends `string` | | `SS` | `SS` | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_2}% | Name | Type | Description | | :------ | :------ | :------ | @@ -697,25 +697,25 @@ Creates a `useStore` function that retrieves the store instance | `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 +#### Returns %{#Module:-pinia-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 +### getActivePinia %{#Module:-pinia-Functions-getActivePinia}% ▸ **getActivePinia**(): `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) Get the currently active pinia if there is any. -#### Returns +#### Returns %{#Module:-pinia-Functions-getActivePinia-Returns}% `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### mapActions +### mapActions %{#Module:-pinia-Functions-mapActions}% ▸ **mapActions**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> @@ -741,7 +741,7 @@ export default { } ``` -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters}% | Name | Type | | :------ | :------ | @@ -751,14 +751,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `A`\> | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapActions-Returns}% [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> @@ -784,7 +784,7 @@ export default { } ``` -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -793,20 +793,20 @@ export default { | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapActions-Returns_1}% [`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> ___ -### mapGetters +### mapGetters %{#Module:-pinia-Functions-mapGetters}% ▸ **mapGetters**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -816,7 +816,7 @@ Alias for `mapState()`. You should use `mapState()` instead. use `mapState()` instead. -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters}% | Name | Type | | :------ | :------ | @@ -826,14 +826,14 @@ use `mapState()` instead. | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters}% | Name | Type | | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | | `keyMapper` | `KeyMapper` | -#### Returns +#### Returns %{#Module:-pinia-Functions-mapGetters-Returns}% [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -845,7 +845,7 @@ Alias for `mapState()`. You should use `mapState()` instead. use `mapState()` instead. -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -855,20 +855,20 @@ use `mapState()` instead. | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters_1}% | Name | Type | | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | | `keys` | readonly `Keys`[] | -#### Returns +#### Returns %{#Module:-pinia-Functions-mapGetters-Returns_1}% [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> ___ -### mapState +### mapState %{#Module:-pinia-Functions-mapState}% ▸ **mapState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -905,7 +905,7 @@ export default { } ``` -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters}% | Name | Type | | :------ | :------ | @@ -915,14 +915,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapState-Returns}% [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -948,7 +948,7 @@ export default { } ``` -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -958,20 +958,20 @@ export default { | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapState-Returns_1}% [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> ___ -### mapStores +### mapStores %{#Module:-pinia-Functions-mapStores}% ▸ **mapStores**<`Stores`\>(...`stores`): [`_Spread`](pinia.md#_spread)<`Stores`\> @@ -995,25 +995,25 @@ export default { } ``` -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapStores-Type-parameters}% | Name | Type | | :------ | :------ | | `Stores` | extends `any`[] | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-mapStores-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `...stores` | [...Stores[]] | list of stores to map to an object | -#### Returns +#### Returns %{#Module:-pinia-Functions-mapStores-Returns}% [`_Spread`](pinia.md#_spread)<`Stores`\> ___ -### mapWritableState +### mapWritableState %{#Module:-pinia-Functions-mapWritableState}% ▸ **mapWritableState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> @@ -1021,7 +1021,7 @@ Same as `mapState()` but creates computed setters as well so the state can be modified. Differently from `mapState()`, only `state` properties can be added. -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters}% | Name | Type | | :------ | :------ | @@ -1031,14 +1031,14 @@ added. | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S`\> | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns}% [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> @@ -1048,7 +1048,7 @@ Allows using state and getters from one store without using the composition API (`setup()`) by generating an object to be spread in the `computed` field of a component. -#### Type parameters +#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -1057,39 +1057,39 @@ of a component. | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### Parameters +#### Parameters %{#Module:-pinia-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 +#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns_1}% [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> ___ -### setActivePinia +### setActivePinia %{#Module:-pinia-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 +#### Parameters %{#Module:-pinia-Functions-setActivePinia-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `pinia` | `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) | Pinia instance | -#### Returns +#### Returns %{#Module:-pinia-Functions-setActivePinia-Returns}% `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### setMapStoreSuffix +### setMapStoreSuffix %{#Module:-pinia-Functions-setMapStoreSuffix}% ▸ **setMapStoreSuffix**(`suffix`): `void` @@ -1097,38 +1097,38 @@ Changes the suffix added by `mapStores()`. Can be set to an empty string. Defaults to `"Store"`. Make sure to extend the MapStoresCustomization interface if you are using TypeScript. -#### Parameters +#### Parameters %{#Module:-pinia-Functions-setMapStoreSuffix-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `suffix` | `string` | new suffix | -#### Returns +#### Returns %{#Module:-pinia-Functions-setMapStoreSuffix-Returns}% `void` ___ -### skipHydrate +### skipHydrate %{#Module:-pinia-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 +#### Type parameters %{#Module:-pinia-Functions-skipHydrate-Type-parameters}% | Name | Type | | :------ | :------ | | `T` | `any` | -#### Parameters +#### Parameters %{#Module:-pinia-Functions-skipHydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `obj` | `T` | target object | -#### Returns +#### Returns %{#Module:-pinia-Functions-skipHydrate-Returns}% `T` @@ -1136,27 +1136,27 @@ obj ___ -### storeToRefs +### storeToRefs %{#Module:-pinia-Functions-storeToRefs}% -▸ **storeToRefs**<`SS`\>(`store`): `ToRefs`<[`StoreState`](pinia.md#storestate)<`SS`\> & [`StoreGetters`](pinia.md#storegetters)<`SS`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<[`StoreState`](pinia.md#storestate)<`SS`\>\>\> +▸ **storeToRefs**<`SS`\>(`store`): `StoreToRefs`<`SS`\> Creates an object of references with all the state, getters, and plugin-added state properties of the store. Similar to `toRefs()` but specifically designed for Pinia stores so methods and non reactive properties are completely ignored. -#### Type parameters +#### Type parameters %{#Module:-pinia-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 +#### Parameters %{#Module:-pinia-Functions-storeToRefs-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `store` | `SS` | store to extract the refs from | -#### Returns +#### Returns %{#Module:-pinia-Functions-storeToRefs-Returns}% -`ToRefs`<[`StoreState`](pinia.md#storestate)<`SS`\> & [`StoreGetters`](pinia.md#storegetters)<`SS`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<[`StoreState`](pinia.md#storestate)<`SS`\>\>\> +`StoreToRefs`<`SS`\> diff --git a/packages/docs-new/api/modules/pinia_nuxt.md b/packages/docs-new/api/modules/pinia_nuxt.md index 63178af0..ca9184bc 100644 --- a/packages/docs-new/api/modules/pinia_nuxt.md +++ b/packages/docs-new/api/modules/pinia_nuxt.md @@ -6,19 +6,19 @@ sidebarDepth: 3 [API Documentation](../index.md) / @pinia/nuxt -# Module: @pinia/nuxt +# Module: @pinia/nuxt %{#Module:-@pinia/nuxt}% -## Interfaces +## Interfaces %{#Module:-@pinia/nuxt-Interfaces}% - [ModuleOptions](../interfaces/pinia_nuxt.ModuleOptions.md) -## Functions +## Functions %{#Module:-@pinia/nuxt-Functions}% -### default +### default %{#Module:-@pinia/nuxt-Functions-default}% ▸ **default**(`this`, `inlineOptions`, `nuxt`): `void` \| `Promise`<`void`\> -#### Parameters +#### Parameters %{#Module:-@pinia/nuxt-Functions-default-Parameters}% | Name | Type | | :------ | :------ | @@ -26,6 +26,6 @@ sidebarDepth: 3 | `inlineOptions` | [`ModuleOptions`](../interfaces/pinia_nuxt.ModuleOptions.md) | | `nuxt` | `Nuxt` | -#### Returns +#### Returns %{#Module:-@pinia/nuxt-Functions-default-Returns}% `void` \| `Promise`<`void`\> diff --git a/packages/docs-new/api/modules/pinia_testing.md b/packages/docs-new/api/modules/pinia_testing.md index d15b7146..eba072e4 100644 --- a/packages/docs-new/api/modules/pinia_testing.md +++ b/packages/docs-new/api/modules/pinia_testing.md @@ -6,16 +6,16 @@ sidebarDepth: 3 [API Documentation](../index.md) / @pinia/testing -# Module: @pinia/testing +# Module: @pinia/testing %{#Module:-@pinia/testing}% -## Interfaces +## Interfaces %{#Module:-@pinia/testing-Interfaces}% - [TestingOptions](../interfaces/pinia_testing.TestingOptions.md) - [TestingPinia](../interfaces/pinia_testing.TestingPinia.md) -## Functions +## Functions %{#Module:-@pinia/testing-Functions}% -### createTestingPinia +### createTestingPinia %{#Module:-@pinia/testing-Functions-createTestingPinia}% ▸ **createTestingPinia**(`options?`): [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md) @@ -26,13 +26,13 @@ You can change this with the `stubActions` option. If you are using jest, they are replaced with `jest.fn()`, otherwise, you must provide your own `createSpy` option. -#### Parameters +#### Parameters %{#Module:-@pinia/testing-Functions-createTestingPinia-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `options` | [`TestingOptions`](../interfaces/pinia_testing.TestingOptions.md) | options to configure the testing pinia | -#### Returns +#### Returns %{#Module:-@pinia/testing-Functions-createTestingPinia-Returns}% [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md) diff --git a/packages/docs-new/zh/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs-new/zh/api/interfaces/pinia.DefineSetupStoreOptions.md index 685c323b..905f7f1d 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs-new/zh/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -32,7 +32,7 @@ sidebarDepth: 3 ↳ **`DefineSetupStoreOptions`** -## 属性 %{#properties}% +## 属性 ### actions %{#actions}% diff --git a/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptions.md index dc94ce7b..97e82677 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptions.md @@ -32,7 +32,7 @@ sidebarDepth: 3 ↳ **`DefineStoreOptions`** -## 属性 %{#properties}% +## 属性 ### actions %{#actions}% @@ -69,7 +69,7 @@ ___ 创建一个新 state 的函数。 **必须是一个箭头函数**，以确保正确的类型标注! -##### 返回值 %{#returns}% +##### 返回值 `S` @@ -100,13 +100,13 @@ const useStore = defineStore('main', { }) ``` -#### 参数 %{#parameters}% +#### 参数 | 名字 | 类型 | 描述 | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### 返回值 %{#returns}% +#### 返回值 `void` diff --git a/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index d72f6e8a..6b0348b5 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs-new/zh/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -27,7 +27,7 @@ sidebarDepth: 3 ↳ **`DefineStoreOptionsInPlugin`** -## 属性 %{#properties}% +## 属性 ### actions %{#actions}% @@ -45,7 +45,7 @@ ___ getter 的可选对象 -#### 继承于 %{#inherited-from}% +#### 继承于 Omit.getters @@ -62,11 +62,11 @@ ___ 创建一个新 state 的函数。 **必须是一个箭头函数**，以确保正确的类型标注! -#### 返回值 %{#returns}% +#### 返回值 `S` -#### 继承于 %{#inherited-from}% +#### 继承于 Omit.state @@ -97,17 +97,17 @@ const useStore = defineStore('main', { }) ``` -#### 参数 %{#parameters}% +#### 参数 | 名字 | 类型 | 描述 | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### 返回值 %{#returns}% +#### 返回值 `void` -#### 继承于 %{#inherited-from}% +#### 继承于 Omit.hydrate diff --git a/packages/docs-new/zh/api/interfaces/pinia.Pinia.md b/packages/docs-new/zh/api/interfaces/pinia.Pinia.md index ef6cf2fc..c98b216d 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.Pinia.md +++ b/packages/docs-new/zh/api/interfaces/pinia.Pinia.md @@ -18,7 +18,7 @@ Every application must own its own pinia to be able to create stores ↳ [`TestingPinia`](pinia_testing.TestingPinia.md) -## 属性 %{#properties}% +## 属性 ### 安装 %{#install}% @@ -28,13 +28,13 @@ Every application must own its own pinia to be able to create stores ▸ (`app`): `void` -##### 参数 %{#parameters}% +##### 参数 | Name | Type | | :------ | :------ | | `app` | `App`<`any`\> | -##### 返回值 %{#returns}% +##### 返回值 `void` @@ -60,6 +60,6 @@ ___ | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### 返回值 %{#returns}% +#### 返回值 [`Pinia`](pinia.Pinia.md) diff --git a/packages/docs-new/zh/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs-new/zh/api/interfaces/pinia.PiniaCustomProperties.md index f1db00a4..efb0fd41 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs-new/zh/api/interfaces/pinia.PiniaCustomProperties.md @@ -27,18 +27,18 @@ sidebarDepth: 3 • `get` **route**(): `RouteLocationNormalized` -#### 返回值 %{#returns}% +#### 返回值 `RouteLocationNormalized` • `set` **route**(`value`): `void` -#### 参数 %{#parameters}% +#### 参数 | Name | Type | | :------ | :------ | | `value` | `RouteLocationNormalizedLoaded` \| `Ref`<`RouteLocationNormalizedLoaded`\> | -#### 返回值 %{#returns}% +#### 返回值 `void` diff --git a/packages/docs-new/zh/api/interfaces/pinia.PiniaPlugin.md b/packages/docs-new/zh/api/interfaces/pinia.PiniaPlugin.md index 0e0983d2..819454b6 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs-new/zh/api/interfaces/pinia.PiniaPlugin.md @@ -19,12 +19,12 @@ sidebarDepth: 3 用于扩展每个 store 的插件。返回一个扩展 store 的对象或 没有返回值。 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 `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)\>\> diff --git a/packages/docs-new/zh/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs-new/zh/api/interfaces/pinia.PiniaPluginContext.md index 6a9747f6..69a86709 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs-new/zh/api/interfaces/pinia.PiniaPluginContext.md @@ -21,7 +21,7 @@ sidebarDepth: 3 | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## 属性 %{#properties}% +## 属性 ### app %{#app}% diff --git a/packages/docs-new/zh/api/interfaces/pinia.StoreDefinition.md b/packages/docs-new/zh/api/interfaces/pinia.StoreDefinition.md index a5cd0927..1a31816f 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs-new/zh/api/interfaces/pinia.StoreDefinition.md @@ -27,18 +27,18 @@ sidebarDepth: 3 返回一个 store，有需要才创建它。 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `pinia?` | ``null`` \| [`Pinia`](pinia.Pinia.md) | Pinia instance to retrieve the store | | `hot?` | [`StoreGeneric`](../modules/pinia.md#storegeneric) | dev only hot module replacement | -#### 返回值 %{#returns}% +#### 返回值 [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> -## 属性 %{#properties}% +## 属性 ### $id %{#id}% diff --git a/packages/docs-new/zh/api/interfaces/pinia.StoreProperties.md b/packages/docs-new/zh/api/interfaces/pinia.StoreProperties.md index defe476f..c1fd2078 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs-new/zh/api/interfaces/pinia.StoreProperties.md @@ -24,7 +24,7 @@ sidebarDepth: 3 ↳ [`_StoreWithState`](pinia._StoreWithState.md) -## 属性 %{#properties}% +## 属性 ### $id %{#id}% diff --git a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index 88a7d200..4dd12224 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -20,7 +20,7 @@ sidebarDepth: 3 ↳ **`SubscriptionCallbackMutationDirect`** -## 属性 %{#properties}% +## 属性 ### 事件 %{#events}% @@ -36,7 +36,7 @@ ___ 执行 mutation 的 store 的 `id` -#### 继承于 %{#inherited-from}% +#### 继承于 [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) diff --git a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index 76f166d1..b4fd9001 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -19,7 +19,7 @@ sidebarDepth: 3 ↳ **`SubscriptionCallbackMutationPatchFunction`** -## 属性 %{#properties}% +## 属性 ### 事件 %{#events}% @@ -35,7 +35,7 @@ ___ 执行 mutation 的 store 的 `id` -#### 继承于 %{#inherited-from}% +#### 继承于 [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) diff --git a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index fc5058fb..4361605f 100644 --- a/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs-new/zh/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -25,7 +25,7 @@ sidebarDepth: 3 ↳ **`SubscriptionCallbackMutationPatchObject`** -## 属性 %{#properties}% +## 属性 ### 事件 %{#events}% @@ -49,7 +49,7 @@ ___ 执行 mutation 的 store 的 `id` -#### 继承于 %{#inherited-from}% +#### 继承于 [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) diff --git a/packages/docs-new/zh/api/interfaces/pinia._StoreOnActionListenerContext.md b/packages/docs-new/zh/api/interfaces/pinia._StoreOnActionListenerContext.md index 32a54c23..60241954 100644 --- a/packages/docs-new/zh/api/interfaces/pinia._StoreOnActionListenerContext.md +++ b/packages/docs-new/zh/api/interfaces/pinia._StoreOnActionListenerContext.md @@ -22,7 +22,7 @@ sidebarDepth: 3 | `ActionName` | extends `string` | | `A` | `A` | -## 属性 %{#properties}% +## 属性 ### after %{#after}% @@ -41,7 +41,7 @@ action 执行完的钩子。 | :------ | :------ | | `callback` | `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` : () => `void` | -##### 返回值 %{#returns}% +##### 返回值 `void` @@ -55,7 +55,7 @@ ___ ___ -### name %{#args}% +### name %{#name}% • **name**: `ActionName` @@ -67,20 +67,20 @@ ___ • **onError**: (`callback`: (`error`: `unknown`) => `void`) => `void` -#### 类型声明 %{#type-declaration}% +#### 类型声明 %{#type-declaration_1}% ▸ (`callback`): `void` action 的错误钩子。 返回 `false` 以捕获错误并阻止其继续传播。 -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `callback` | (`error`: `unknown`) => `void` | -##### 返回值 %{#returns}% +##### 返回值 `void` diff --git a/packages/docs-new/zh/api/interfaces/pinia._StoreWithState.md b/packages/docs-new/zh/api/interfaces/pinia._StoreWithState.md index 849e1ec3..9537aee7 100644 --- a/packages/docs-new/zh/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs-new/zh/api/interfaces/pinia._StoreWithState.md @@ -27,7 +27,7 @@ sidebarDepth: 3 ↳ **`_StoreWithState`** -## 属性 %{#properties}% +## 属性 ### $id %{#id}% @@ -35,7 +35,7 @@ sidebarDepth: 3 store 的唯一标识符 -#### 继承于 %{#inherited-from}% +#### 继承于 [StoreProperties](pinia.StoreProperties.md).[$id](pinia.StoreProperties.md#$id) @@ -57,7 +57,7 @@ ___ 生产版本会被移除。 用户可以用它来添加应在 devtools 中显示的 store 属性键。 -#### 继承自 %{#inherited-from}% +#### 继承自 [StoreProperties](pinia.StoreProperties.md).[_customProperties](pinia.StoreProperties.md#_customproperties) @@ -71,7 +71,7 @@ ___ 插件可以覆盖此方法来清理已添加的任何副作用函数。 例如， devtools 插件停止显示来自 devtools 的已停止的 store。 -#### 返回值 %{#returns}% +#### 返回值 `void` @@ -113,14 +113,14 @@ store.$onAction(({ after, onError }) => { }) ``` -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 `fn` @@ -160,7 +160,7 @@ store.$onAction(({ after, onError }) => { }) ``` -##### 返回值 %{#returns}% +##### 返回值 `void` @@ -174,13 +174,13 @@ ___ 将一个 state 补丁应用于当前状态。允许传递嵌套值 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `partialState` | [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`UnwrapRef`<`S`\>\> | patch to apply to the state | -#### 返回值 %{#returns}% +#### 返回值 `void` @@ -190,13 +190,13 @@ ___ 当 mutation 对象(如 Sets 或数组)或者应用对象补丁不方便时很有用，例如追加到数组中。 传递给 `$patch()` 的函数**必须是同步的**。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 %{#type-parameters_1}% | 名称 | 类型 | | :------ | :------ | | `F` | extends (`state`: `UnwrapRef`<`S`\>) => `any` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | @@ -215,7 +215,7 @@ ___ 通过建立一个新的状态对象，将 store 重设为初始状态。 TODO: make this options only -#### 返回值 %{#returns}% +#### 返回值 `void` @@ -229,14 +229,14 @@ ___ 请注意，当在组件内调用 `store.$subscribe()` 时，除非 `detached` 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 `fn` @@ -248,7 +248,7 @@ ___ 请注意，当在组件内调用 `store.$subscribe()` 时，除非 `detached` 被设置为 true， 否则当组件被卸载时，它将被自动清理掉。 -##### 返回值 %{#returns}% +##### 返回值 `void` diff --git a/packages/docs-new/zh/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs-new/zh/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index 4f01a3a5..d1be6957 100644 --- a/packages/docs-new/zh/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs-new/zh/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -22,7 +22,7 @@ sidebarDepth: 3 ↳ [`SubscriptionCallbackMutationPatchObject`](pinia.SubscriptionCallbackMutationPatchObject.md) -## 属性 %{#properties}% +## 属性 ### storeId %{#storeid}% diff --git a/packages/docs-new/zh/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs-new/zh/api/interfaces/pinia_testing.TestingOptions.md index 647c3de4..503299f6 100644 --- a/packages/docs-new/zh/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs-new/zh/api/interfaces/pinia_testing.TestingOptions.md @@ -10,7 +10,7 @@ sidebarDepth: 3 [@pinia/testing](../modules/pinia_testing.md).TestingOptions -## 属性 %{#properties}% +## 属性 ### createSpy %{#createspy}% @@ -23,25 +23,25 @@ sidebarDepth: 3 用于创建 action 和 `$patch()` 的 spy 的函数。 在 jest 项目中默认为 `jest.fn()`，在 vitest 项目中默认为 `vi.fn()`。 -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `fn?` | (...`args`: `any`[]) => `any` | -##### 返回值 %{#returns}% +##### 返回值 `fn` ▸ (...`args`): `any` -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `...args` | `any`[] | -##### 返回值 %{#returns}% +##### 返回值 `any` diff --git a/packages/docs-new/zh/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs-new/zh/api/interfaces/pinia_testing.TestingPinia.md index 298cd20e..398174cc 100644 --- a/packages/docs-new/zh/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs-new/zh/api/interfaces/pinia_testing.TestingPinia.md @@ -19,7 +19,7 @@ sidebarDepth: 3 ↳ **`TestingPinia`** -## 属性 %{#properties}% +## 属性 ### app %{#app}% @@ -37,17 +37,17 @@ ___ ▸ (`app`): `void` -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `app` | `App`<`any`\> | -##### 返回值 %{#returns}% +##### 返回值 `void` -#### 继承于 %{#inherited-from}% +#### 继承于 [Pinia](pinia.Pinia.md).[install](pinia.Pinia.md#install) @@ -59,7 +59,7 @@ ___ 根 state -#### 继承于 %{#inherited-from}% +#### 继承于 [Pinia](pinia.Pinia.md).[state](pinia.Pinia.md#state) @@ -71,16 +71,16 @@ ___ 增加了一个 store 插件来扩展每个 store -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### 返回值 %{#returns}% +#### 返回值 [`Pinia`](pinia.Pinia.md) -#### 继承于 %{#inherited-from}% +#### 继承于 [Pinia](pinia.Pinia.md).[use](pinia.Pinia.md#use) diff --git a/packages/docs-new/zh/api/modules/pinia.md b/packages/docs-new/zh/api/modules/pinia.md index 1df76a82..9f95cc48 100644 --- a/packages/docs-new/zh/api/modules/pinia.md +++ b/packages/docs-new/zh/api/modules/pinia.md @@ -61,7 +61,7 @@ ___ 创建 store 的 Store 类型。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :--------------------------------------------- | @@ -79,7 +79,7 @@ ___ 提取一个 store 类型的 action。 对 Setup Store 或 Option Store 都有效。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :--- | @@ -104,7 +104,7 @@ ___ 提取一个 store 类型的 getter。 对 Setup Store 或 Option Store都有效。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :--- | @@ -116,7 +116,7 @@ ___ Ƭ **StoreOnActionListener**<`Id`, `S`, `G`, `A`\>: (`context`: [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\>) => `void` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :---------------------------------------- | @@ -131,13 +131,13 @@ ___ `store.$onAction()` 的参数 -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\> | -##### 返回值 %{#returns}% +##### 返回值 `void` @@ -150,7 +150,7 @@ ___ 传递给 `store.$onAction(context => {})` 的回调的上下文对象。 TODO：应该只有Id，Store 和 Action 来生成适当的对象。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :---------------------------------------- | @@ -168,7 +168,7 @@ ___ 提取一个 store 类型的 state。 对 Setup Store 或 Option Store 都有效。请注意，它自动解包 refs。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :--- | @@ -180,7 +180,7 @@ ___ Ƭ **SubscriptionCallback**<`S`\>: (`mutation`: [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\>, `state`: `UnwrapRef`<`S`\>) => `void` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -192,14 +192,14 @@ ___ 订阅的回调 -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `mutation` | [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\> | | `state` | `UnwrapRef`<`S`\> | -##### 返回值 %{#returns}% +##### 返回值 `void` @@ -211,7 +211,7 @@ ___ 传递给订阅回调的上下文对象。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :--- | @@ -232,7 +232,7 @@ ___ Ƭ **\_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}% +#### 类型参数 | 名称 | | :--- | @@ -248,7 +248,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -262,7 +262,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -277,7 +277,7 @@ ___ 能够通过 IDE 进行重构的类型。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -291,7 +291,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -306,7 +306,7 @@ ___ 能够通过 IDE 进行重构的类型。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -320,7 +320,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -335,7 +335,7 @@ ___ 能够通过 IDE 进行重构的类型。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -350,7 +350,7 @@ ___ 推断参数的 Getter 对象的类型。仅供内部使用。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -364,7 +364,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -379,7 +379,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -393,7 +393,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -411,7 +411,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -427,7 +427,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -442,7 +442,7 @@ ___ **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | Type | | :------ | :------ | @@ -454,7 +454,7 @@ ___ Ƭ **\_Method**: (...`args`: `any`[]) => `any` -#### 类型声明 %{#type-declaration}% +#### 类型声明 %{#type-declaration_1}% ▸ (...`args`): `any` @@ -462,13 +462,13 @@ Generic type for a function that can infer arguments and return type **仅**供内部使用 -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :------ | :------ | | `...args` | `any`[] | -##### 返回值 %{#returns}% +##### 返回值 `any` @@ -480,7 +480,7 @@ ___ **仅**供内部使用. -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -494,7 +494,7 @@ ___ **仅**供内部使用. -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -509,7 +509,7 @@ ___ 为 action 增强的 Store。仅供内部使用。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -524,7 +524,7 @@ ___ Store augmented with getters. For internal usage only. **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -539,7 +539,7 @@ ___ 能够通过 IDE 进行重构的类型。 **仅**供内部使用 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | | :------ | @@ -592,26 +592,26 @@ if (import.meta.hot) { } ``` -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 `fn` ▸ (`newModule`): `any` -##### 参数 %{#parameters}% +##### 参数 | 名称 | 类型 | | :---------- | :---- | | `newModule` | `any` | -##### 返回值 %{#returns}% +##### 返回值 `any` @@ -623,7 +623,7 @@ ___ 创建一个 Pinia 实例，供应用使用。 -#### 返回值 %{#returns}% +#### 返回值 [`Pinia`](../interfaces/pinia.Pinia.md) @@ -635,7 +635,7 @@ ___ 创建一个 `useStore` 函数，检索 store 实例 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :--------------------------------------------- | @@ -644,14 +644,14 @@ ___ | `G` | 扩展自 `_GettersTree`<`S`\> = {} | | `A` | {} | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -659,7 +659,7 @@ ___ 创建一个 `useStore` 函数，检索 store 实例 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :------ | @@ -668,13 +668,13 @@ ___ | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | | `A` | {} | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `options` | [`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\> | options to define the store | -#### 返回值 %{#returns}% +#### 返回值 [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -682,14 +682,14 @@ ___ 创建一个 `useStore` 函数，检索 store 实例 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :--------------- | | `Id` | 扩展自 `string` | | `SS` | `SS` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | @@ -697,7 +697,7 @@ ___ | `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}% +#### 返回值 [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> @@ -709,7 +709,7 @@ ___ 如果有的话，获取当前激活的 pinia -#### 返回值 %{#returns}% +#### 返回值 `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) @@ -741,7 +741,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :---------- | :---------------------------------------- | @@ -751,14 +751,14 @@ export default { | `A` | `A` | | `KeyMapper` | 扩展自 `Record`<`string`, keyof `A`\> | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `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}% +#### 返回值 [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> @@ -784,7 +784,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :--- | :---------------------------------------- | @@ -793,14 +793,14 @@ export default { | `G` | 扩展自 [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | keyof `A`[] | array of action names to map | -#### 返回值 %{#returns}% +#### 返回值 [`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> @@ -843,7 +843,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -853,14 +853,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object of state properties or getters | -#### 返回值 %{#returns}% +#### 返回值 [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -886,7 +886,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -896,14 +896,14 @@ export default { | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | readonly `Keys`[] | array of state properties or getters | -#### 返回值 %{#returns}% +#### 返回值 [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> @@ -945,7 +945,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -955,14 +955,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object of state properties or getters | -#### 返回值 %{#returns}% +#### 返回值 [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -988,7 +988,7 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -998,14 +998,14 @@ export default { | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | readonly `Keys`[] | array of state properties or getters | -#### 返回值 %{#returns}% +#### 返回值 [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> @@ -1035,19 +1035,19 @@ export default { } ``` -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------- | :-------------- | | `Stores` | 扩展 `any`[] | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :---------- | :------------ | :--------------------------------- | | `...stores` | [...Stores[]] | list of stores to map to an object | -#### 返回值 %{#returns}% +#### 返回值 [`_Spread`](pinia.md#_spread)<`Stores`\> @@ -1061,7 +1061,7 @@ ___ 所以 state 可以被修改。 与 `mapState()` 不同的是，只有 `state` 属性可以被添加。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -1071,14 +1071,14 @@ ___ | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S`\> | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object of state properties | -#### 返回值 %{#returns}% +#### 返回值 [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> @@ -1088,7 +1088,7 @@ ___ 以允许在不使用组合式 API(`setup()`)的情况下 使用来自一个 store 的 state 和 getter，。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | @@ -1097,14 +1097,14 @@ ___ | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | keyof `S`[] | array of state properties | -#### 返回值 %{#returns}% +#### 返回值 [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> @@ -1117,13 +1117,13 @@ ___ 设置或取消设置激活的 pinia。 在 SSR 和内部调用 action 和 getter 时使用。 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `pinia` | `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) | Pinia instance | -#### 返回值 %{#returns}% +#### 返回值 `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) @@ -1143,7 +1143,7 @@ ___ | :------ | :------ | :------ | | `suffix` | `string` | new suffix | -#### 返回值 %{#returns}% +#### 返回值 `void` @@ -1156,19 +1156,19 @@ ___ 告诉 Pinia 跳过给定对象的激活过程。当你在 store 中返回一个有状态的对象，但它并不是真正的状态时，(仅)在 setup store 中这是很有用的。 例如，在一个 setup store 中返回一个路由器实例。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | | `T` | `any` | -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `obj` | `T` | target object | -#### 返回值 %{#returns}% +#### 返回值 `T` @@ -1185,18 +1185,18 @@ getter 和 plugin 添加的 state 属性。 类似于 `toRefs()`，但专门为 Pinia store 设计， 所以 method 和非响应式属性会被完全忽略。 -#### 类型参数 %{#type-parameters}% +#### 类型参数 | 名称 | 类型 | | :------ | :------ | | `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}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :--- | :------ | | `store` | `SS` | store to extract the refs from | -#### 返回值 %{#returns}% +#### 返回值 `ToRefs`<[`StoreState`](pinia.md#storestate)<`SS`\> & [`StoreGetters`](pinia.md#storegetters)<`SS`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<[`StoreState`](pinia.md#storestate)<`SS`\>\>\> diff --git a/packages/docs-new/zh/api/modules/pinia_nuxt.md b/packages/docs-new/zh/api/modules/pinia_nuxt.md index 387e0d1f..4bc53cf7 100644 --- a/packages/docs-new/zh/api/modules/pinia_nuxt.md +++ b/packages/docs-new/zh/api/modules/pinia_nuxt.md @@ -18,7 +18,7 @@ sidebarDepth: 3 ▸ **default**(`this`, `inlineOptions`, `nuxt`): `void` \| `Promise`<`void`\> -#### 参数 %{#parameters}% +#### 参数 | Name | Type | | :------ | :------ | @@ -26,6 +26,6 @@ sidebarDepth: 3 | `inlineOptions` | [`ModuleOptions`](../interfaces/pinia_nuxt.ModuleOptions.md) | | `nuxt` | `Nuxt` | -#### 返回值 %{#returns}% +#### 返回值 `void` \| `Promise`<`void`\> diff --git a/packages/docs-new/zh/api/modules/pinia_testing.md b/packages/docs-new/zh/api/modules/pinia_testing.md index b531dde2..64cb5c0c 100644 --- a/packages/docs-new/zh/api/modules/pinia_testing.md +++ b/packages/docs-new/zh/api/modules/pinia_testing.md @@ -26,13 +26,13 @@ sidebarDepth: 3 如果你使用 jest，将它们替换为 `jest.fn()`， 否则，你必须提供你自己的 `createSpy` 选项。 -#### 参数 %{#parameters}% +#### 参数 | 名称 | 类型 | 描述 | | :------ | :------ | :------ | | `options` | [`TestingOptions`](../interfaces/pinia_testing.TestingOptions.md) | 配置 pinia 测试实例的选项 | -#### 返回值 %{#returns}% +#### 返回值 [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md)