diff --git a/packages/docs/api/pinia/index.md b/packages/docs/api/pinia/index.md index 38339fbe68..fc1eb1e654 100644 --- a/packages/docs/api/pinia/index.md +++ b/packages/docs/api/pinia/index.md @@ -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) diff --git a/packages/docs/api/pinia/interfaces/DefineStoreOptions.md b/packages/docs/api/pinia/interfaces/DefineStoreOptions.md index 056e64334b..c1090d319f 100644 --- a/packages/docs/api/pinia/interfaces/DefineStoreOptions.md +++ b/packages/docs/api/pinia/interfaces/DefineStoreOptions.md @@ -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. diff --git a/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md b/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md index 543a0f0b9a..21996b5f16 100644 --- a/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md +++ b/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md @@ -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. diff --git a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md index 2eb0e0ba96..bc487d6321 100644 --- a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md +++ b/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md @@ -10,7 +10,7 @@ editLink: false # Type Alias: \_ExtractActionsFromSetupStore\ -> **\_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** diff --git a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md index bff8313522..2bf518a5cc 100644 --- a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md +++ b/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md @@ -10,7 +10,7 @@ editLink: false # Type Alias: \_ExtractGettersFromSetupStore\ -> **\_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** diff --git a/packages/docs/api/pinia/type-aliases/StoreWithGetters.md b/packages/docs/api/pinia/type-aliases/StoreWithGetters.md index cddd9dec4a..f96e3d5ef1 100644 --- a/packages/docs/api/pinia/type-aliases/StoreWithGetters.md +++ b/packages/docs/api/pinia/type-aliases/StoreWithGetters.md @@ -10,7 +10,7 @@ editLink: false # Type Alias: \_StoreWithGetters\ -> **\_StoreWithGetters**\<`G`\>: `{ readonly [k in keyof G]: G[k] extends Function ? R : UnwrapRef }` +> **\_StoreWithGetters**\<`G`\>: `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> Store augmented with getters. For internal usage only. For internal use **only**