]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
docs: up local copies
authorEduardo San Martin Morote <posva13@gmail.com>
Sun, 3 Nov 2024 19:59:09 +0000 (20:59 +0100)
committerEduardo San Martin Morote <posva13@gmail.com>
Sun, 3 Nov 2024 19:59:09 +0000 (20:59 +0100)
packages/docs/api/pinia/index.md
packages/docs/api/pinia/interfaces/DefineStoreOptions.md
packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md
packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md
packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md
packages/docs/api/pinia/type-aliases/StoreWithGetters.md

index 38339fbe6844af50eecf1016172c7921308fe095..fc1eb1e6545e0f9d79e814137c80d82439abb9dd 100644 (file)
@@ -92,5 +92,6 @@ editLink: false
 - [mapWritableState](functions/mapWritableState.md)
 - [setActivePinia](functions/setActivePinia.md)
 - [setMapStoreSuffix](functions/setMapStoreSuffix.md)
+- [shouldHydrate](functions/shouldHydrate.md)
 - [skipHydrate](functions/skipHydrate.md)
 - [storeToRefs](functions/storeToRefs.md)
index 056e64334bf279094b4ad8dc5c25a00a5f812934..c1090d319fd6835e38e68c3b14eebfee53e0a64f 100644 (file)
@@ -35,7 +35,7 @@ augment stores with the plugin API.
 
 ### actions?
 
-> `optional` **actions**: `A` & `ThisType`\<`A` & `UnwrapRef`\<`S`\> & [`_StoreWithState`](StoreWithState.md)\<`Id`, `S`, `G`, `A`\> & [`_StoreWithGetters`](../type-aliases/StoreWithGetters.md)\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\>
+> `optional` **actions**: `A` & `ThisType`\<`A` & `UnwrapRef`\<`S`\> & [`_StoreWithState`](StoreWithState.md)\<`Id`, `S`, `G`, `A`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\>
 
 Optional object of actions.
 
@@ -43,7 +43,7 @@ Optional object of actions.
 
 ### getters?
 
-> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & [`_StoreWithGetters`](../type-aliases/StoreWithGetters.md)\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\>
+> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\>
 
 Optional object of getters.
 
index 543a0f0b9ad3cef00ef020e95763d88a93127d03..21996b5f16a4ae2086a2303270babc8b0dd3cd2a 100644 (file)
@@ -40,7 +40,7 @@ Defaults to an empty object if no actions are defined.
 
 ### getters?
 
-> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & [`_StoreWithGetters`](../type-aliases/StoreWithGetters.md)\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\>
+> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\>
 
 Optional object of getters.
 
index 2eb0e0ba960dad4d816d97a9ec72465d81ba46ac..bc487d6321e40da2845cb06c3499e9e0a7dc2faf 100644 (file)
@@ -10,7 +10,7 @@ editLink: false
 
 # Type Alias: \_ExtractActionsFromSetupStore\<SS\>
 
-> **\_ExtractActionsFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : [`_ExtractActionsFromSetupStore_Keys`](ExtractActionsFromSetupStore_Keys.md)\<`SS`\> *extends* keyof `SS` ? `Pick`\<`SS`, [`_ExtractActionsFromSetupStore_Keys`](ExtractActionsFromSetupStore_Keys.md)\<`SS`\>\> : `never`
+> **\_ExtractActionsFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractActionsFromSetupStore_Keys`](ExtractActionsFromSetupStore_Keys.md)\<`SS`\>\>
 
 For internal use **only**
 
index bff8313522837eb09493a012322acac2f0fa7eba..2bf518a5cc106e5df2ddbf23057cbba534375549 100644 (file)
@@ -10,7 +10,7 @@ editLink: false
 
 # Type Alias: \_ExtractGettersFromSetupStore\<SS\>
 
-> **\_ExtractGettersFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : [`_ExtractGettersFromSetupStore_Keys`](ExtractGettersFromSetupStore_Keys.md)\<`SS`\> *extends* keyof `SS` ? `Pick`\<`SS`, [`_ExtractGettersFromSetupStore_Keys`](ExtractGettersFromSetupStore_Keys.md)\<`SS`\>\> : `never`
+> **\_ExtractGettersFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractGettersFromSetupStore_Keys`](ExtractGettersFromSetupStore_Keys.md)\<`SS`\>\>
 
 For internal use **only**
 
index cddd9dec4ac512d3bd907cb3f96c64fc5579a59f..f96e3d5ef1a2a6e61b76714497ff3049d220b473 100644 (file)
@@ -10,7 +10,7 @@ editLink: false
 
 # Type Alias: \_StoreWithGetters\<G\>
 
-> **\_StoreWithGetters**\<`G`\>: `{ readonly [k in keyof G]: G[k] extends Function ? R : UnwrapRef<G[k]> }`
+> **\_StoreWithGetters**\<`G`\>: `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\>
 
 Store augmented with getters. For internal usage only.
 For internal use **only**