From: Eduardo San Martin Morote Date: Tue, 29 Mar 2022 17:08:45 +0000 (+0200) Subject: docs: fix dead links X-Git-Tag: @pinia/testing@0.0.11~15 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=25a9304e334b3657aa08b18e3f6b136b67546eaf;p=thirdparty%2Fvuejs%2Fpinia.git docs: fix dead links --- diff --git a/packages/docs/api/enums/pinia.MutationType.md b/packages/docs/api/enums/pinia.MutationType.md index cf1347ab..b508c4ca 100644 --- a/packages/docs/api/enums/pinia.MutationType.md +++ b/packages/docs/api/enums/pinia.MutationType.md @@ -26,7 +26,7 @@ Direct mutation of the state: #### Defined in -[pinia/src/types.ts:50](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L50) +[pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L50) ___ @@ -40,7 +40,7 @@ Mutated the state with `$patch` and a function #### Defined in -[pinia/src/types.ts:64](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L64) +[pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L64) ___ @@ -54,4 +54,4 @@ Mutated the state with `$patch` and an object #### Defined in -[pinia/src/types.ts:57](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L57) +[pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L57) diff --git a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md index e6557ae5..6d6ab7e9 100644 --- a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -40,4 +40,4 @@ store defined with a setup function. Note this is always defined #### Defined in -[pinia/src/types.ts:706](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L706) +[pinia/src/types.ts:704](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L704) diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md index 5bcaa90f..06db8361 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md @@ -32,25 +32,25 @@ augment stores with the plugin API. @see [DefineStoreOptionsBase](pinia.DefineSt ### actions -• `Optional` **actions**: `A` & `ThisType`<`A` & `UnwrapRef`<`S`\> & [`_StoreWithState`](pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & `_StoreWithGetters`<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), `_GettersTree`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\>\> +• `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)\>\> Optional object of actions. #### Defined in -[pinia/src/types.ts:654](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L654) +[pinia/src/types.ts:652](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L652) ___ ### getters -• `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & `_StoreWithGetters`<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), `_GettersTree`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\>\> & `_GettersTree`<`S`\> +• `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. #### Defined in -[pinia/src/types.ts:647](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L647) +[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L645) ___ @@ -62,7 +62,7 @@ Unique string key to identify the store across the application. #### Defined in -[pinia/src/types.ts:636](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L636) +[pinia/src/types.ts:634](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L634) ## Methods @@ -103,7 +103,7 @@ const useStore = defineStore('main', { #### Defined in -[pinia/src/types.ts:687](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L687) +[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L685) ___ @@ -120,4 +120,4 @@ correct typings! #### Defined in -[pinia/src/types.ts:642](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L642) +[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L640) diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index 13689f50..588bbd84 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -39,13 +39,13 @@ Defaults to an empty object if no actions are defined. #### Defined in -[pinia/src/types.ts:723](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L723) +[pinia/src/types.ts:721](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L721) ___ ### getters -• `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & `_StoreWithGetters`<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), `_GettersTree`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\>\> & `_GettersTree`<`S`\> +• `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. @@ -55,7 +55,7 @@ Omit.getters #### Defined in -[pinia/src/types.ts:647](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L647) +[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L645) ## Methods @@ -100,7 +100,7 @@ Omit.hydrate #### Defined in -[pinia/src/types.ts:687](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L687) +[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L685) ___ @@ -121,4 +121,4 @@ Omit.state #### Defined in -[pinia/src/types.ts:642](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L642) +[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L640) diff --git a/packages/docs/api/interfaces/pinia.Pinia.md b/packages/docs/api/interfaces/pinia.Pinia.md index bc391fef..5ee4f68a 100644 --- a/packages/docs/api/interfaces/pinia.Pinia.md +++ b/packages/docs/api/interfaces/pinia.Pinia.md @@ -28,7 +28,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:51](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L51) +[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L51) ## Methods @@ -48,7 +48,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:46](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L46) +[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L46) ___ @@ -70,4 +70,4 @@ Adds a store plugin to extend every store #### Defined in -[pinia/src/rootStore.ts:58](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L58) +[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L58) diff --git a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md index 8743ec2b..fbc8d867 100644 --- a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md @@ -18,8 +18,8 @@ Interface to be extended by the user when they add properties through plugins. | :------ | :------ | | `Id` | extends `string` = `string` | | `S` | extends [`StateTree`](../modules/pinia.md#statetree) = [`StateTree`](../modules/pinia.md#statetree) | -| `G` | `_GettersTree`<`S`\> | -| `A` | `_ActionsTree` | +| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | +| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | ## Properties @@ -31,7 +31,7 @@ Nuxt context. #### Defined in -[nuxt/src/module.ts:68](https://github.com/posva/pinia/blob/46c50b2/packages/nuxt/src/module.ts#L68) +[nuxt/src/module.ts:68](https://github.com/vuejs/pinia/blob/d96dca2/packages/nuxt/src/module.ts#L68) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:14](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L14) +[pinia/__tests__/storePlugins.spec.ts:14](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L14) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:11](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L11) +[pinia/__tests__/storePlugins.spec.ts:11](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L11) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:12](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L12) +[pinia/__tests__/storePlugins.spec.ts:12](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L12) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:9](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L9) +[pinia/__tests__/storePlugins.spec.ts:9](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L9) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:10](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L10) +[pinia/__tests__/storePlugins.spec.ts:10](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L10) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:7](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L7) +[pinia/__tests__/storePlugins.spec.ts:7](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L7) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:13](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L13) +[pinia/__tests__/storePlugins.spec.ts:13](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L13) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:8](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/__tests__/storePlugins.spec.ts#L8) +[pinia/__tests__/storePlugins.spec.ts:8](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/__tests__/storePlugins.spec.ts#L8) ## Accessors @@ -125,7 +125,7 @@ ___ #### Defined in -[playground/src/main.ts:17](https://github.com/posva/pinia/blob/46c50b2/packages/playground/src/main.ts#L17) +[playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/d96dca2/packages/playground/src/main.ts#L17) • `set` **route**(`value`): `void` @@ -141,4 +141,4 @@ ___ #### Defined in -[playground/src/main.ts:14](https://github.com/posva/pinia/blob/46c50b2/packages/playground/src/main.ts#L14) +[playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/d96dca2/packages/playground/src/main.ts#L14) diff --git a/packages/docs/api/interfaces/pinia.PiniaPlugin.md b/packages/docs/api/interfaces/pinia.PiniaPlugin.md index bf2818c8..c63e0895 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs/api/interfaces/pinia.PiniaPlugin.md @@ -14,7 +14,7 @@ sidebarDepth: 3 ### PiniaPlugin -▸ **PiniaPlugin**(`context`): `void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), `_GettersTree`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\> & `PiniaCustomStateProperties`<[`StateTree`](../modules/pinia.md#statetree)\>\> +▸ **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`<[`StateTree`](../modules/pinia.md#statetree)\>\> Plugin to extend every store. Returns an object to extend the store or nothing. @@ -23,12 +23,12 @@ nothing. | Name | Type | Description | | :------ | :------ | :------ | -| `context` | [`PiniaPluginContext`](pinia.PiniaPluginContext.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), `_GettersTree`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\> | Context | +| `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`<[`StateTree`](../modules/pinia.md#statetree)\>, `_ActionsTree`\> & `PiniaCustomStateProperties`<[`StateTree`](../modules/pinia.md#statetree)\>\> +`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`<[`StateTree`](../modules/pinia.md#statetree)\>\> #### Defined in -[pinia/src/rootStore.ts:140](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L140) +[pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L140) diff --git a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md index c17aa155..21114e33 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md @@ -18,8 +18,8 @@ Context argument passed to Pinia plugins. | :------ | :------ | | `Id` | extends `string` = `string` | | `S` | extends [`StateTree`](../modules/pinia.md#statetree) = [`StateTree`](../modules/pinia.md#statetree) | -| `G` | `_GettersTree`<`S`\> | -| `A` | `_ActionsTree` | +| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | +| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | ## Properties @@ -31,7 +31,7 @@ Current app created with `Vue.createApp()`. #### Defined in -[pinia/src/rootStore.ts:117](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L117) +[pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L117) ___ @@ -43,7 +43,7 @@ Current store being extended. #### Defined in -[pinia/src/rootStore.ts:127](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L127) +[pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L127) ___ @@ -55,7 +55,7 @@ pinia instance. #### Defined in -[pinia/src/rootStore.ts:112](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L112) +[pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L112) ___ @@ -67,4 +67,4 @@ Current store being extended. #### Defined in -[pinia/src/rootStore.ts:122](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L122) +[pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L122) diff --git a/packages/docs/api/interfaces/pinia.StoreDefinition.md b/packages/docs/api/interfaces/pinia.StoreDefinition.md index 933888df..cdd2308d 100644 --- a/packages/docs/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs/api/interfaces/pinia.StoreDefinition.md @@ -16,8 +16,8 @@ sidebarDepth: 3 | :------ | :------ | | `Id` | extends `string` = `string` | | `S` | extends [`StateTree`](../modules/pinia.md#statetree) = [`StateTree`](../modules/pinia.md#statetree) | -| `G` | `_GettersTree`<`S`\> | -| `A` | `_ActionsTree` | +| `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | +| `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | ## Callable @@ -40,7 +40,7 @@ Returns a store, creates it if necessary. #### Defined in -[pinia/src/types.ts:513](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L513) +[pinia/src/types.ts:511](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L511) ## Properties @@ -52,4 +52,4 @@ Id of the store. Used by map helpers. #### Defined in -[pinia/src/types.ts:518](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L518) +[pinia/src/types.ts:516](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L516) diff --git a/packages/docs/api/interfaces/pinia.StoreProperties.md b/packages/docs/api/interfaces/pinia.StoreProperties.md index f662fb78..4270a614 100644 --- a/packages/docs/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs/api/interfaces/pinia.StoreProperties.md @@ -34,4 +34,18 @@ Unique identifier of the store #### Defined in -[pinia/src/types.ts:265](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L265) +[pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L265) + +___ + +### \_customProperties + +• **\_customProperties**: `Set`<`string`\> + +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. + +#### Defined in + +[pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L293) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index 2cc90de2..dbd1ee33 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -30,7 +30,7 @@ DEV ONLY. Different mutation calls. #### Defined in -[pinia/src/types.ts:96](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L96) +[pinia/src/types.ts:96](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L96) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L81) +[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L81) ___ @@ -62,4 +62,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:91](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L91) +[pinia/src/types.ts:91](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L91) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index d9881f9c..76297f46 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -29,7 +29,7 @@ DEV ONLY. Array of all the mutations done inside of the callback. #### Defined in -[pinia/src/types.ts:129](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L129) +[pinia/src/types.ts:129](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L129) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L81) +[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L81) ___ @@ -61,4 +61,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:124](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L124) +[pinia/src/types.ts:124](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L124) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index d4ab5df8..20d424c9 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -35,19 +35,19 @@ DEV ONLY. Array for patch calls. #### Defined in -[pinia/src/types.ts:110](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L110) +[pinia/src/types.ts:110](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L110) ___ ### payload -• **payload**: `_DeepPartial`<`S`\> +• **payload**: [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`S`\> Object passed to `store.$patch()`. #### Defined in -[pinia/src/types.ts:115](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L115) +[pinia/src/types.ts:115](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L115) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L81) +[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L81) ___ @@ -79,4 +79,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:105](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L105) +[pinia/src/types.ts:105](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L105) diff --git a/packages/docs/api/interfaces/pinia._StoreWithState.md b/packages/docs/api/interfaces/pinia._StoreWithState.md index 6871b574..8f2bc4b4 100644 --- a/packages/docs/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs/api/interfaces/pinia._StoreWithState.md @@ -41,7 +41,7 @@ Unique identifier of the store #### Defined in -[pinia/src/types.ts:265](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L265) +[pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L265) ___ @@ -53,7 +53,25 @@ State of the Store. Setting it will replace the whole state. #### Defined in -[pinia/src/types.ts:337](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L337) +[pinia/src/types.ts:335](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L335) + +___ + +### \_customProperties + +• **\_customProperties**: `Set`<`string`\> + +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 + +[StoreProperties](pinia.StoreProperties.md).[_customProperties](pinia.StoreProperties.md#_customproperties) + +#### Defined in + +[pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L293) ## Methods @@ -71,7 +89,7 @@ e.g. devtools plugin stops displaying disposed stores from devtools. #### Defined in -[pinia/src/types.ts:425](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L425) +[pinia/src/types.ts:423](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L423) ___ @@ -164,7 +182,7 @@ function that removes the watcher #### Defined in -[pinia/src/types.ts:415](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L415) +[pinia/src/types.ts:413](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L413) ___ @@ -178,7 +196,7 @@ Applies a state patch to current state. Allows passing nested values | Name | Type | Description | | :------ | :------ | :------ | -| `partialState` | `_DeepPartial`<`UnwrapRef`<`S`\>\> | patch to apply to the state | +| `partialState` | [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`UnwrapRef`<`S`\>\> | patch to apply to the state | #### Returns @@ -186,7 +204,7 @@ Applies a state patch to current state. Allows passing nested values #### Defined in -[pinia/src/types.ts:344](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L344) +[pinia/src/types.ts:342](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L342) ▸ **$patch**<`F`\>(`stateMutator`): `void` @@ -212,7 +230,7 @@ to an array. The function passed to `$patch()` **must be synchronous**. #### Defined in -[pinia/src/types.ts:353](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L353) +[pinia/src/types.ts:351](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L351) ___ @@ -229,7 +247,7 @@ TODO: make this options only #### Defined in -[pinia/src/types.ts:362](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L362) +[pinia/src/types.ts:360](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L360) ___ @@ -268,4 +286,4 @@ function that removes the watcher #### Defined in -[pinia/src/types.ts:374](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L374) +[pinia/src/types.ts:372](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L372) diff --git a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index ef598eee..559cfc91 100644 --- a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -32,7 +32,7 @@ Base type for the context passed to a subscription callback. Internal type. #### Defined in -[pinia/src/types.ts:81](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L81) +[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L81) ___ @@ -44,4 +44,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:76](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L76) +[pinia/src/types.ts:76](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L76) diff --git a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md index 3899e7da..512e50e6 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md @@ -23,7 +23,7 @@ Defaults to false. #### Defined in -[testing/src/testing.ts:45](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L45) +[testing/src/testing.ts:45](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L45) ___ @@ -36,7 +36,7 @@ allowing you to only set a few properties that are required in your test. #### Defined in -[testing/src/testing.ts:15](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L15) +[testing/src/testing.ts:15](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L15) ___ @@ -49,7 +49,7 @@ your application that will be used while testing. #### Defined in -[testing/src/testing.ts:21](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L21) +[testing/src/testing.ts:21](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L21) ___ @@ -65,7 +65,7 @@ handle this in `createSpy()`. #### Defined in -[testing/src/testing.ts:30](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L30) +[testing/src/testing.ts:30](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L30) ___ @@ -79,7 +79,7 @@ argument `undefined`. You still have to handle this in `createSpy()`. #### Defined in -[testing/src/testing.ts:37](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L37) +[testing/src/testing.ts:37](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L37) ## Methods @@ -88,7 +88,7 @@ argument `undefined`. You still have to handle this in `createSpy()`. ▸ `Optional` **createSpy**(`fn?`): (...`args`: `any`[]) => `any` Function used to create a spy for actions and `$patch()`. Pre-configured -with `jest.fn()` in jest projects. +with `jest.fn()` in jest projects or `vi.fn()` in vitest projects. #### Parameters @@ -114,4 +114,4 @@ with `jest.fn()` in jest projects. #### Defined in -[testing/src/testing.ts:51](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L51) +[testing/src/testing.ts:51](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L51) diff --git a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md index 6d7e67ff..8c49de0a 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md @@ -29,7 +29,7 @@ App used by Pinia #### Defined in -[testing/src/testing.ts:60](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L60) +[testing/src/testing.ts:60](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L60) ___ @@ -45,7 +45,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:51](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L51) +[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L51) ## Methods @@ -69,7 +69,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:46](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L46) +[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L46) ___ @@ -95,4 +95,4 @@ Adds a store plugin to extend every store #### Defined in -[pinia/src/rootStore.ts:58](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L58) +[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L58) diff --git a/packages/docs/api/modules/pinia.md b/packages/docs/api/modules/pinia.md index d51244c5..6b8c57f8 100644 --- a/packages/docs/api/modules/pinia.md +++ b/packages/docs/api/modules/pinia.md @@ -29,6 +29,7 @@ sidebarDepth: 3 - [SubscriptionCallbackMutationDirect](../interfaces/pinia.SubscriptionCallbackMutationDirect.md) - [SubscriptionCallbackMutationPatchFunction](../interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md) - [SubscriptionCallbackMutationPatchObject](../interfaces/pinia.SubscriptionCallbackMutationPatchObject.md) +- [\_StoreOnActionListenerContext](../interfaces/pinia._StoreOnActionListenerContext.md) - [\_StoreWithState](../interfaces/pinia._StoreWithState.md) - [\_SubscriptionCallbackMutationBase](../interfaces/pinia._SubscriptionCallbackMutationBase.md) @@ -44,7 +45,7 @@ Plugin to extend every store. #### Defined in -[pinia/src/rootStore.ts:149](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L149) +[pinia/src/rootStore.ts:149](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L149) ___ @@ -56,34 +57,34 @@ Generic state of a Store #### Defined in -[pinia/src/types.ts:13](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L13) +[pinia/src/types.ts:13](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L13) ___ ### Store -Ƭ **Store**<`Id`, `S`, `G`, `A`\>: [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & `UnwrapRef`<`S`\> & `_StoreWithGetters`<`G`\> & `_ActionsTree` extends `A` ? {} : `A` & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`Id`, `S`, `G`, `A`\> & `PiniaCustomStateProperties`<`S`\> +Ƭ **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`<`S`\> Store type to build a store. #### Type parameters -| Name | Type | -| :--- | :--------------------------------------------- | -| `Id` | extends `string` = `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) = {} | -| `G` | {} | -| `A` | {} | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` = `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) = {} | +| `G` | {} | +| `A` | {} | #### Defined in -[pinia/src/types.ts:472](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L472) +[pinia/src/types.ts:470](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L470) ___ ### StoreActions -Ƭ **StoreActions**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, infer A\> ? `A` : `_ExtractActionsFromSetupStore`<`SS`\> +Ƭ **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. @@ -91,18 +92,18 @@ Options Store. #### Type parameters | Name | -| :--- | +| :------ | | `SS` | #### Defined in -[pinia/src/store.ts:727](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L727) +[pinia/src/store.ts:727](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L727) ___ ### StoreGeneric -Ƭ **StoreGeneric**: [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, `_ActionsTree`\> +Ƭ **StoreGeneric**: [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> Generic and type-unsafe version of Store. Doesn't fail on access with strings, making it much easier to write generic functions that do not care @@ -110,13 +111,13 @@ about the kind of store that is passed. #### Defined in -[pinia/src/types.ts:491](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L491) +[pinia/src/types.ts:489](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L489) ___ ### StoreGetters -Ƭ **StoreGetters**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), infer G, `_ActionsTree`\> ? `_StoreWithGetters`<`G`\> : `_ExtractGettersFromSetupStore`<`SS`\> +Ƭ **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. @@ -124,27 +125,27 @@ Options Store. #### Type parameters | Name | -| :--- | +| :------ | | `SS` | #### Defined in -[pinia/src/store.ts:740](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L740) +[pinia/src/store.ts:740](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L740) ___ ### StoreOnActionListener -Ƭ **StoreOnActionListener**<`Id`, `S`, `G`, `A`\>: (`context`: [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? `_ActionsTree` : `A`\>) => `void` +Ƭ **StoreOnActionListener**<`Id`, `S`, `G`, `A`\>: (`context`: [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\>) => `void` #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | `G` | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | `G` | +| `A` | `A` | #### Type declaration @@ -154,9 +155,9 @@ Argument of `store.$onAction()` ##### Parameters -| Name | Type | -| :-------- | :------------------------------------------------------------------------------------------------------------------------------ | -| `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? `_ActionsTree` : `A`\> | +| Name | Type | +| :------ | :------ | +| `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\> | ##### Returns @@ -164,35 +165,35 @@ Argument of `store.$onAction()` #### Defined in -[pinia/src/types.ts:243](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L243) +[pinia/src/types.ts:243](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L243) ___ ### StoreOnActionListenerContext -Ƭ **StoreOnActionListenerContext**<`Id`, `S`, `G`, `A`\>: `_ActionsTree` extends `A` ? `_StoreOnActionListenerContext`<[`StoreGeneric`](pinia.md#storegeneric), `string`, `_ActionsTree`\> : { [Name in keyof A]: Name extends string ? \_StoreOnActionListenerContext, Name, A\> : never }[keyof `A`] +Ƭ **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 -| Name | Type | -| :--- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | `G` | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | `G` | +| `A` | `A` | #### Defined in -[pinia/src/types.ts:227](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L227) +[pinia/src/types.ts:227](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L227) ___ ### StoreState -Ƭ **StoreState**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, infer S, `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, `_ActionsTree`\> ? `UnwrapRef`<`S`\> : `_ExtractStateFromSetupStore`<`SS`\> +Ƭ **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. @@ -200,12 +201,12 @@ Options Store. Note this unwraps refs. #### Type parameters | Name | -| :--- | +| :------ | | `SS` | #### Defined in -[pinia/src/store.ts:753](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L753) +[pinia/src/store.ts:753](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L753) ___ @@ -216,8 +217,8 @@ ___ #### Type parameters | Name | -| :--- | -| `S` | +| :------ | +| `S` | #### Type declaration @@ -227,10 +228,10 @@ Callback of a subscription ##### Parameters -| Name | Type | -| :--------- | :---------------------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `mutation` | [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\> | -| `state` | `UnwrapRef`<`S`\> | +| `state` | `UnwrapRef`<`S`\> | ##### Returns @@ -238,7 +239,7 @@ Callback of a subscription #### Defined in -[pinia/src/types.ts:148](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L148) +[pinia/src/types.ts:148](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L148) ___ @@ -251,12 +252,25 @@ Context object passed to a subscription callback. #### Type parameters | Name | -| :--- | -| `S` | +| :------ | +| `S` | #### Defined in -[pinia/src/types.ts:140](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L140) +[pinia/src/types.ts:140](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L140) + +___ + +### \_ActionsTree + +Ƭ **\_ActionsTree**: `Record`<`string`, [`_Method`](pinia.md#_method)\> + +Type of an object of Actions. For internal usage only. +For internal use **only** + +#### Defined in + +[pinia/src/types.ts:555](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L555) ___ @@ -267,12 +281,399 @@ ___ #### Type parameters | Name | -| :--- | -| `T` | +| :------ | +| `T` | + +#### Defined in + +[pinia/src/types.ts:164](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L164) + +___ + +### \_DeepPartial + +Ƭ **\_DeepPartial**<`T`\>: { [K in keyof T]?: \_DeepPartial } + +Recursive `Partial`. Used by {@link Store.$patch}. + +For internal use **only** + +#### Type parameters + +| Name | +| :------ | +| `T` | + +#### Defined in + +[pinia/src/types.ts:35](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L35) + +___ + +### \_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 + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:599](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L599) + +___ + +### \_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 + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:569](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L569) + +___ + +### \_ExtractGettersFromSetupStore + +Ƭ **\_ExtractGettersFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\> extends keyof `SS` ? [`_UnwrapAll`](pinia.md#_unwrapall)<`Pick`<`SS`, [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\>\>\> : `never` + +For internal use **only** + +#### Type parameters + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:608](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L608) + +___ + +### \_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 + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:577](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L577) + +___ + +### \_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 + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:590](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L590) + +___ + +### \_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 + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:561](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L561) + +___ + +### \_GettersTree + +Ƭ **\_GettersTree**<`S`\>: `Record`<`string`, (`state`: `UnwrapRef`<`S`\> & `UnwrapRef`<`PiniaCustomStateProperties`<`S`\>\>) => `any` \| () => `any`\> + +Type of an object of Getters that infers the argument. For internal usage only. +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`StateTree`](pinia.md#statetree) | + +#### Defined in + +[pinia/src/types.ts:545](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L545) + +___ + +### \_MapActionsObjectReturn + +Ƭ **\_MapActionsObjectReturn**<`A`, `T`\>: { [key in keyof T]: A[T[key]] } + +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `A` | `A` | +| `T` | extends `Record`<`string`, keyof `A`\> | + +#### Defined in + +[pinia/src/mapHelpers.ts:297](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L297) + +___ + +### \_MapActionsReturn + +Ƭ **\_MapActionsReturn**<`A`\>: { [key in keyof A]: A[key] } + +For internal use **only** + +#### Type parameters + +| Name | +| :------ | +| `A` | #### Defined in -[pinia/src/types.ts:164](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/types.ts#L164) +[pinia/src/mapHelpers.ts:290](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L290) + +___ + +### \_MapStateObjectReturn + +Ƭ **\_MapStateObjectReturn**<`Id`, `S`, `G`, `A`, `T`\>: { [key in keyof T]: Function } + +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | +| `T` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> = {} | + +#### Defined in + +[pinia/src/mapHelpers.ts:141](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L141) + +___ + +### \_MapStateReturn + +Ƭ **\_MapStateReturn**<`S`, `G`, `Keys`\>: { [key in Keys]: Function } + +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `Keys` | extends keyof `S` \| keyof `G` = keyof `S` \| keyof `G` | + +#### Defined in + +[pinia/src/mapHelpers.ts:125](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L125) + +___ + +### \_MapWritableStateObjectReturn + +Ƭ **\_MapWritableStateObjectReturn**<`S`, `T`\>: { [key in keyof T]: Object } + +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `T` | extends `Record`<`string`, keyof `S`\> | + +#### Defined in + +[pinia/src/mapHelpers.ts:422](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L422) + +___ + +### \_MapWritableStateReturn + +Ƭ **\_MapWritableStateReturn**<`S`\>: { [key in keyof S]: Object } + +For internal use **only** + +#### Type parameters + +| Name | Type | +| :------ | :------ | +| `S` | extends [`StateTree`](pinia.md#statetree) | + +#### Defined in + +[pinia/src/mapHelpers.ts:412](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L412) + +___ + +### \_Method + +Ƭ **\_Method**: (...`args`: `any`[]) => `any` + +#### Type declaration + +▸ (...`args`): `any` + +Generic type for a function that can infer arguments and return type + +For internal use **only** + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `...args` | `any`[] | + +##### Returns + +`any` + +#### Defined in + +[pinia/src/types.ts:439](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L439) + +___ + +### \_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 + +| Name | Type | +| :------ | :------ | +| `A` | extends readonly `any`[] | + +#### Defined in + +[pinia/src/mapHelpers.ts:53](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L53) + +___ + +### \_StoreObject + +Ƭ **\_StoreObject**<`S`\>: `S` extends [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md) ? { [Id in \`${Ids}${MapStoresCustomization extends Record<"suffix", string\> ? MapStoresCustomization["suffix"] : "Store"}\`]: Function } : {} + +For internal use **only**. + +#### Type parameters + +| Name | +| :------ | +| `S` | + +#### Defined in + +[pinia/src/mapHelpers.ts:25](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L25) + +___ + +### \_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 + +| Name | +| :------ | +| `A` | + +#### Defined in + +[pinia/src/types.ts:451](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L451) + +___ + +### \_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 + +| Name | +| :------ | +| `G` | + +#### Defined in + +[pinia/src/types.ts:461](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L461) + +___ + +### \_UnwrapAll + +Ƭ **\_UnwrapAll**<`SS`\>: { [K in keyof SS]: UnwrapRef } + +Type that enables refactoring through IDE. +For internal use **only** + +#### Type parameters + +| Name | +| :------ | +| `SS` | + +#### Defined in + +[pinia/src/types.ts:585](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/types.ts#L585) ## Variables @@ -303,7 +704,7 @@ new Vue({ #### Defined in -[pinia/src/vue2-plugin.ts:28](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/vue2-plugin.ts#L28) +[pinia/src/vue2-plugin.ts:28](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/vue2-plugin.ts#L28) ## Functions @@ -323,10 +724,10 @@ if (import.meta.hot) { #### Parameters -| Name | Type | Description | -| :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------- | -| `initialUseStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`string`, [`StateTree`](pinia.md#statetree), `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, `_ActionsTree`\> | return of the defineStore to hot update | -| `hot` | `any` | `import.meta.hot` | +| 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 @@ -336,8 +737,8 @@ if (import.meta.hot) { ##### Parameters -| Name | Type | -| :---------- | :---- | +| Name | Type | +| :------ | :------ | | `newModule` | `any` | ##### Returns @@ -346,7 +747,7 @@ if (import.meta.hot) { #### Defined in -[pinia/src/hmr.ts:73](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/hmr.ts#L73) +[pinia/src/hmr.ts:73](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/hmr.ts#L73) ___ @@ -362,7 +763,7 @@ Creates a Pinia instance to be used by the application #### Defined in -[pinia/src/createPinia.ts:10](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/createPinia.ts#L10) +[pinia/src/createPinia.ts:10](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/createPinia.ts#L10) ___ @@ -374,19 +775,19 @@ Creates a `useStore` function that retrieves the store instance #### Type parameters -| Name | Type | -| :--- | :--------------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) = {} | -| `G` | extends `_GettersTree`<`S`\> = {} | -| `A` | {} | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) = {} | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | +| `A` | {} | #### 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 | +| 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 @@ -394,7 +795,7 @@ Creates a `useStore` function that retrieves the store instance #### Defined in -[pinia/src/store.ts:776](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L776) +[pinia/src/store.ts:776](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L776) ▸ **defineStore**<`Id`, `S`, `G`, `A`\>(`options`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -402,17 +803,17 @@ Creates a `useStore` function that retrieves the store instance #### Type parameters -| Name | Type | -| :--- | :--------------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) = {} | -| `G` | extends `_GettersTree`<`S`\> = {} | -| `A` | {} | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) = {} | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | +| `A` | {} | #### Parameters -| Name | Type | Description | -| :-------- | :-------------------------------------------------------------------------------------- | :-------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `options` | [`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\> | options to define the store | #### Returns @@ -421,34 +822,34 @@ Creates a `useStore` function that retrieves the store instance #### Defined in -[pinia/src/store.ts:792](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L792) +[pinia/src/store.ts:792](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L792) -▸ **defineStore**<`Id`, `SS`\>(`id`, `storeSetup`, `options?`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `_ExtractStateFromSetupStore`<`SS`\>, `_ExtractGettersFromSetupStore`<`SS`\>, `_ExtractActionsFromSetupStore`<`SS`\>\> +▸ **defineStore**<`Id`, `SS`\>(`id`, `storeSetup`, `options?`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> Creates a `useStore` function that retrieves the store instance #### Type parameters -| Name | Type | -| :--- | :--------------- | +| Name | Type | +| :------ | :------ | | `Id` | extends `string` | -| `SS` | `SS` | +| `SS` | `SS` | #### Parameters -| Name | Type | Description | -| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------- | -| `id` | `Id` | id of the store (must be unique) | -| `storeSetup` | () => `SS` | function that defines the store | -| `options?` | [`DefineSetupStoreOptions`](../interfaces/pinia.DefineSetupStoreOptions.md)<`Id`, `_ExtractStateFromSetupStore`<`SS`\>, `_ExtractGettersFromSetupStore`<`SS`\>, `_ExtractActionsFromSetupStore`<`SS`\>\> | extra options | +| Name | Type | Description | +| :------ | :------ | :------ | +| `id` | `Id` | id of the store (must be unique) | +| `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`<`SS`\>, `_ExtractGettersFromSetupStore`<`SS`\>, `_ExtractActionsFromSetupStore`<`SS`\>\> +[`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> #### Defined in -[pinia/src/store.ts:807](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L807) +[pinia/src/store.ts:807](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L807) ___ @@ -464,13 +865,13 @@ Get the currently active pinia if there is any. #### Defined in -[pinia/src/rootStore.ts:39](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L39) +[pinia/src/rootStore.ts:39](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L39) ___ ### mapActions -▸ **mapActions**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): `_MapActionsObjectReturn`<`A`, `KeyMapper`\> +▸ **mapActions**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> Allows directly using actions from your store without using the composition API (`setup()`) by generating an object to be spread in the `methods` field @@ -495,30 +896,30 @@ export default { #### Type parameters -| Name | Type | -| :---------- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | -| `KeyMapper` | extends `Record`<`string`, keyof `A`\> | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | +| `KeyMapper` | extends `Record`<`string`, keyof `A`\> | #### 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 | +| 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 -`_MapActionsObjectReturn`<`A`, `KeyMapper`\> +[`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> #### Defined in -[pinia/src/mapHelpers.ts:326](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L326) +[pinia/src/mapHelpers.ts:326](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L326) -▸ **mapActions**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): `_MapActionsReturn`<`A`\> +▸ **mapActions**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> Allows directly using actions from your store without using the composition API (`setup()`) by generating an object to be spread in the `methods` field @@ -541,33 +942,33 @@ export default { #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | #### Parameters -| 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 | +| 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 -`_MapActionsReturn`<`A`\> +[`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> #### Defined in -[pinia/src/mapHelpers.ts:359](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L359) +[pinia/src/mapHelpers.ts:359](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L359) ___ ### mapGetters -▸ `Const` **mapGetters**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): `_MapStateObjectReturn`<`Id`, `S`, `G`, `A`, `KeyMapper`\> +▸ `Const` **mapGetters**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> Alias for `mapState()`. You should use `mapState()` instead. @@ -575,30 +976,30 @@ Alias for `mapState()`. You should use `mapState()` instead. #### Type parameters -| Name | Type | -| :---------- | :------------------------------------------------------------------------------------------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | #### Parameters -| Name | Type | -| :---------- | :-------------------------------------------------------------------------------- | -| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | -| `keyMapper` | `KeyMapper` | +| Name | Type | +| :------ | :------ | +| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | +| `keyMapper` | `KeyMapper` | #### Returns -`_MapStateObjectReturn`<`Id`, `S`, `G`, `A`, `KeyMapper`\> +[`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> #### Defined in -[pinia/src/mapHelpers.ts:285](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L285) +[pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L285) -▸ `Const` **mapGetters**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): `_MapStateReturn`<`S`, `G`, `Keys`\> +▸ `Const` **mapGetters**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> Alias for `mapState()`. You should use `mapState()` instead. @@ -606,34 +1007,34 @@ Alias for `mapState()`. You should use `mapState()` instead. #### Type parameters -| Name | Type | -| :----- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | -| `Keys` | extends `string` \| `number` \| `symbol` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | +| `Keys` | extends `string` \| `number` \| `symbol` | #### Parameters -| Name | Type | -| :--------- | :-------------------------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | -| `keys` | readonly `Keys`[] | +| `keys` | readonly `Keys`[] | #### Returns -`_MapStateReturn`<`S`, `G`, `Keys`\> +[`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> #### Defined in -[pinia/src/mapHelpers.ts:285](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L285) +[pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L285) ___ ### mapState -▸ **mapState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): `_MapStateObjectReturn`<`Id`, `S`, `G`, `A`, `KeyMapper`\> +▸ **mapState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> 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 @@ -669,30 +1070,30 @@ export default { #### Type parameters -| Name | Type | -| :---------- | :------------------------------------------------------------------------------------------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | #### 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 | +| 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 -`_MapStateObjectReturn`<`Id`, `S`, `G`, `A`, `KeyMapper`\> +[`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> #### Defined in -[pinia/src/mapHelpers.ts:194](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L194) +[pinia/src/mapHelpers.ts:194](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L194) -▸ **mapState**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): `_MapStateReturn`<`S`, `G`, `Keys`\> +▸ **mapState**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> 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 @@ -715,34 +1116,34 @@ export default { #### Type parameters -| Name | Type | -| :----- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | -| `Keys` | extends `string` \| `number` \| `symbol` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | +| `Keys` | extends `string` \| `number` \| `symbol` | #### Parameters -| 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 | +| 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 -`_MapStateReturn`<`S`, `G`, `Keys`\> +[`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> #### Defined in -[pinia/src/mapHelpers.ts:231](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L231) +[pinia/src/mapHelpers.ts:231](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L231) ___ ### mapStores -▸ **mapStores**<`Stores`\>(...`stores`): `_Spread`<`Stores`\> +▸ **mapStores**<`Stores`\>(...`stores`): [`_Spread`](pinia.md#_spread)<`Stores`\> Allows using stores without the composition API (`setup()`) by generating an object to be spread in the `computed` field of a component. It accepts a list @@ -765,29 +1166,29 @@ export default { #### Type parameters -| Name | Type | -| :------- | :-------------- | +| Name | Type | +| :------ | :------ | | `Stores` | extends `any`[] | #### Parameters -| Name | Type | Description | -| :---------- | :------------ | :--------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `...stores` | [...Stores[]] | list of stores to map to an object | #### Returns -`_Spread`<`Stores`\> +[`_Spread`](pinia.md#_spread)<`Stores`\> #### Defined in -[pinia/src/mapHelpers.ts:96](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L96) +[pinia/src/mapHelpers.ts:96](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L96) ___ ### mapWritableState -▸ **mapWritableState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): `_MapWritableStateObjectReturn`<`S`, `KeyMapper`\> +▸ **mapWritableState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> Same as `mapState()` but creates computed setters as well so the state can be modified. Differently from `mapState()`, only `state` properties can be @@ -795,30 +1196,30 @@ added. #### Type parameters -| Name | Type | -| :---------- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | -| `KeyMapper` | extends `Record`<`string`, keyof `S`\> | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | +| `KeyMapper` | extends `Record`<`string`, keyof `S`\> | #### Parameters -| Name | Type | Description | -| :---------- | :-------------------------------------------------------------------------------- | :------------------------- | -| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | -| `keyMapper` | `KeyMapper` | object of state properties | +| Name | Type | Description | +| :------ | :------ | :------ | +| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | +| `keyMapper` | `KeyMapper` | object of state properties | #### Returns -`_MapWritableStateObjectReturn`<`S`, `KeyMapper`\> +[`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> #### Defined in -[pinia/src/mapHelpers.ts:440](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L440) +[pinia/src/mapHelpers.ts:440](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L440) -▸ **mapWritableState**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): `_MapWritableStateReturn`<`S`\> +▸ **mapWritableState**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> 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 @@ -826,27 +1227,27 @@ of a component. #### Type parameters -| Name | Type | -| :--- | :---------------------------------------- | -| `Id` | extends `string` | -| `S` | extends [`StateTree`](pinia.md#statetree) | -| `G` | extends `_GettersTree`<`S`\> | -| `A` | `A` | +| Name | Type | +| :------ | :------ | +| `Id` | extends `string` | +| `S` | extends [`StateTree`](pinia.md#statetree) | +| `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | +| `A` | `A` | #### Parameters -| Name | Type | Description | -| :--------- | :-------------------------------------------------------------------------------- | :------------------------ | -| `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | -| `keys` | keyof `S`[] | array of state properties | +| 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 -`_MapWritableStateReturn`<`S`\> +[`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> #### Defined in -[pinia/src/mapHelpers.ts:458](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L458) +[pinia/src/mapHelpers.ts:458](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L458) ___ @@ -859,8 +1260,8 @@ actions and getters #### Parameters -| Name | Type | Description | -| :------ | :----------------------------------------------------- | :------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `pinia` | `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) | Pinia instance | #### Returns @@ -869,7 +1270,7 @@ actions and getters #### Defined in -[pinia/src/rootStore.ts:33](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/rootStore.ts#L33) +[pinia/src/rootStore.ts:33](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/rootStore.ts#L33) ___ @@ -883,9 +1284,9 @@ interface if you need are using TypeScript. #### Parameters -| Name | Type | Description | -| :------- | :------- | :---------- | -| `suffix` | `string` | new suffix | +| Name | Type | Description | +| :------ | :------ | :------ | +| `suffix` | `string` | new suffix | #### Returns @@ -893,7 +1294,7 @@ interface if you need are using TypeScript. #### Defined in -[pinia/src/mapHelpers.ts:66](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/mapHelpers.ts#L66) +[pinia/src/mapHelpers.ts:66](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/mapHelpers.ts#L66) ___ @@ -903,15 +1304,15 @@ ___ #### Type parameters -| Name | Type | -| :--- | :---- | -| `T` | `any` | +| Name | Type | +| :------ | :------ | +| `T` | `any` | #### Parameters -| Name | Type | -| :---- | :--- | -| `obj` | `T` | +| Name | Type | +| :------ | :------ | +| `obj` | `T` | #### Returns @@ -919,7 +1320,7 @@ ___ #### Defined in -[pinia/src/store.ts:85](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/store.ts#L85) +[pinia/src/store.ts:85](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/store.ts#L85) ___ @@ -934,14 +1335,14 @@ completely ignored. #### Type parameters -| Name | Type | -| :--- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `SS` | extends [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`string`, [`StateTree`](pinia.md#statetree), `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, `_ActionsTree`, `SS`\> & {} & `_StoreWithGetters`<`_GettersTree`<[`StateTree`](pinia.md#statetree)\>\> & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](pinia.md#statetree), `_GettersTree`<[`StateTree`](pinia.md#statetree)\>, `_ActionsTree`, `SS`\> & `PiniaCustomStateProperties`<[`StateTree`](pinia.md#statetree), `SS`\> | +| 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`\> & {} & [`_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`<[`StateTree`](pinia.md#statetree), `SS`\> | #### Parameters -| Name | Type | Description | -| :------ | :--- | :----------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `store` | `SS` | store to extract the refs from | #### Returns @@ -950,4 +1351,4 @@ completely ignored. #### Defined in -[pinia/src/storeToRefs.ts:13](https://github.com/posva/pinia/blob/46c50b2/packages/pinia/src/storeToRefs.ts#L13) +[pinia/src/storeToRefs.ts:21](https://github.com/vuejs/pinia/blob/d96dca2/packages/pinia/src/storeToRefs.ts#L21) diff --git a/packages/docs/api/modules/pinia_testing.md b/packages/docs/api/modules/pinia_testing.md index 541ecb21..0c1f5cdd 100644 --- a/packages/docs/api/modules/pinia_testing.md +++ b/packages/docs/api/modules/pinia_testing.md @@ -40,4 +40,4 @@ a augmented pinia instance #### Defined in -[testing/src/testing.ts:74](https://github.com/posva/pinia/blob/46c50b2/packages/testing/src/testing.ts#L74) +[testing/src/testing.ts:80](https://github.com/vuejs/pinia/blob/d96dca2/packages/testing/src/testing.ts#L80) diff --git a/packages/docs/cookbook/testing.md b/packages/docs/cookbook/testing.md index 3493af7f..3c565341 100644 --- a/packages/docs/cookbook/testing.md +++ b/packages/docs/cookbook/testing.md @@ -73,7 +73,7 @@ This can be achieved with `createTestingPinia()`, which returns a pinia instance Start by installing `@pinia/testing`: -```sh +```shell npm i -D @pinia/testing ``` @@ -163,7 +163,7 @@ expect(store.someAction).toHaveBeenCalledTimes(1) ### Specifying the createSpy function -When using Jest, or vitest with `globals: true`, `createTestingPinia` automatically stubs actions using the spy function based on the existing test framework (`jest.fn` or `vitest.fn`). If you are using a different framework, you'll need to provide a [createSpy](/api/interfaces/pinia_testing.testingoptions.html#createspy) option: +When using Jest, or vitest with `globals: true`, `createTestingPinia` automatically stubs actions using the spy function based on the existing test framework (`jest.fn` or `vitest.fn`). If you are using a different framework, you'll need to provide a [createSpy](/api/interfaces/pinia_testing.TestingOptions.html#createspy) option: ```js import sinon from 'sinon' diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md index 6e37477e..a86ca134 100644 --- a/packages/nuxt/README.md +++ b/packages/nuxt/README.md @@ -4,7 +4,7 @@ ## Installation -```sh +```shell npm i @pinia/nuxt ```