]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
docs: updates
authorEduardo San Martin Morote <posva13@gmail.com>
Mon, 30 Sep 2024 12:56:11 +0000 (14:56 +0200)
committerEduardo San Martin Morote <posva13@gmail.com>
Mon, 30 Sep 2024 12:56:18 +0000 (14:56 +0200)
packages/docs/api/@pinia/nuxt/functions/default.md
packages/docs/api/@pinia/testing/interfaces/TestingPinia.md
packages/docs/api/pinia/index.md
packages/docs/api/pinia/interfaces/Pinia.md
packages/docs/api/pinia/interfaces/StoreProperties.md
packages/docs/api/pinia/interfaces/StoreWithState.md
packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md

index 64c5fe3ff531c0f8d50721b7592913c372e118b7..d7c1376a620c04c5a0e997206c3efc9a4cfdfa4f 100644 (file)
@@ -10,16 +10,16 @@ editLink: false
 
 # Function: default()
 
-> **default**(`this`, `inlineOptions`, `nuxt`): `_ModuleSetupReturn`
+> **default**(`this`, `resolvedOptions`, `nuxt`): `ModuleSetupReturn`
 
 ## Parameters
 
 • **this**: `void`
 
-• **inlineOptions**: [`ModuleOptions`](../interfaces/ModuleOptions.md)
+• **resolvedOptions**: [`ModuleOptions`](../interfaces/ModuleOptions.md)
 
 • **nuxt**: `Nuxt`
 
 ## Returns
 
-`_ModuleSetupReturn`
+`ModuleSetupReturn`
index 1dea5c777b17465e22cd924fd17da860cccc1cdd..1e26372edc26a4607d0bda73075128e322133573 100644 (file)
@@ -47,7 +47,7 @@ App used by Pinia
 
 ### state
 
-> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>\>
+> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>\>
 
 root state
 
index e09ada4308ffcdabe1a82701db71ac1f75647608..38339fbe6844af50eecf1016172c7921308fe095 100644 (file)
@@ -18,6 +18,9 @@ editLink: false
 
 ### Interfaces
 
+- [\_StoreOnActionListenerContext](interfaces/StoreOnActionListenerContext.md)
+- [\_StoreWithState](interfaces/StoreWithState.md)
+- [\_SubscriptionCallbackMutationBase](interfaces/SubscriptionCallbackMutationBase.md)
 - [DefineSetupStoreOptions](interfaces/DefineSetupStoreOptions.md)
 - [DefineStoreOptions](interfaces/DefineStoreOptions.md)
 - [DefineStoreOptionsBase](interfaces/DefineStoreOptionsBase.md)
@@ -34,23 +37,9 @@ editLink: false
 - [SubscriptionCallbackMutationDirect](interfaces/SubscriptionCallbackMutationDirect.md)
 - [SubscriptionCallbackMutationPatchFunction](interfaces/SubscriptionCallbackMutationPatchFunction.md)
 - [SubscriptionCallbackMutationPatchObject](interfaces/SubscriptionCallbackMutationPatchObject.md)
-- [\_StoreOnActionListenerContext](interfaces/StoreOnActionListenerContext.md)
-- [\_StoreWithState](interfaces/StoreWithState.md)
-- [\_SubscriptionCallbackMutationBase](interfaces/SubscriptionCallbackMutationBase.md)
 
 ### Type Aliases
 
-- [PiniaStorePlugin](type-aliases/PiniaStorePlugin.md)
-- [StateTree](type-aliases/StateTree.md)
-- [Store](type-aliases/Store.md)
-- [StoreActions](type-aliases/StoreActions.md)
-- [StoreGeneric](type-aliases/StoreGeneric.md)
-- [StoreGetters](type-aliases/StoreGetters.md)
-- [StoreOnActionListener](type-aliases/StoreOnActionListener.md)
-- [StoreOnActionListenerContext](type-aliases/StoreOnActionListenerContext.md)
-- [StoreState](type-aliases/StoreState.md)
-- [SubscriptionCallback](type-aliases/SubscriptionCallback.md)
-- [SubscriptionCallbackMutation](type-aliases/SubscriptionCallbackMutation.md)
 - [\_ActionsTree](type-aliases/ActionsTree.md)
 - [\_Awaited](type-aliases/Awaited.md)
 - [\_DeepPartial](type-aliases/DeepPartial.md)
@@ -73,6 +62,17 @@ editLink: false
 - [\_StoreWithActions](type-aliases/StoreWithActions.md)
 - [\_StoreWithGetters](type-aliases/StoreWithGetters.md)
 - [\_UnwrapAll](type-aliases/UnwrapAll.md)
+- [PiniaStorePlugin](type-aliases/PiniaStorePlugin.md)
+- [StateTree](type-aliases/StateTree.md)
+- [Store](type-aliases/Store.md)
+- [StoreActions](type-aliases/StoreActions.md)
+- [StoreGeneric](type-aliases/StoreGeneric.md)
+- [StoreGetters](type-aliases/StoreGetters.md)
+- [StoreOnActionListener](type-aliases/StoreOnActionListener.md)
+- [StoreOnActionListenerContext](type-aliases/StoreOnActionListenerContext.md)
+- [StoreState](type-aliases/StoreState.md)
+- [SubscriptionCallback](type-aliases/SubscriptionCallback.md)
+- [SubscriptionCallbackMutation](type-aliases/SubscriptionCallbackMutation.md)
 
 ### Variables
 
index 78153c2807f2ad48a014882f8384b14aaa06b328..190c5d066bd12214dcb5d6b3117c873f4ac1cfe4 100644 (file)
@@ -34,7 +34,7 @@ Every application must own its own pinia to be able to create stores
 
 ### state
 
-> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>\>
+> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>\>
 
 root state
 
index 80adff222dd1bbfb2180c1f11a45fd1352f728bc..22ca27916e79b4ee77befb0498dac82ad187d887 100644 (file)
@@ -22,14 +22,6 @@ Properties of a store.
 
 ## Properties
 
-### $id
-
-> **$id**: `Id`
-
-Unique identifier of the store
-
-***
-
 ### \_customProperties
 
 > **\_customProperties**: `Set`\<`string`\>
@@ -37,3 +29,11 @@ Unique identifier of the store
 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.
+
+***
+
+### $id
+
+> **$id**: `Id`
+
+Unique identifier of the store
index d1927d099b03c279d8c3d696ead6ee7023a5a7d4..3c03565a3dbbbecb90cfbf7b73de08eba9c6111f 100644 (file)
@@ -28,6 +28,20 @@ Base store with state and functions. Should not be used directly.
 
 ## Properties
 
+### \_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`](StoreProperties.md).[`_customProperties`](StoreProperties.md#_customProperties)
+
+***
+
 ### $id
 
 > **$id**: `Id`
@@ -46,20 +60,6 @@ Unique identifier of the store
 
 State of the Store. Setting it will internally call `$patch()` to update the state.
 
-***
-
-### \_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`](StoreProperties.md).[`_customProperties`](StoreProperties.md#_customProperties)
-
 ## Methods
 
 ### $dispose()
index 5cdd0b7b50230d72238676da1e086c55d1373861..91b59ad8fd7577958eecc6e192c197057843124f 100644 (file)
@@ -10,7 +10,7 @@ editLink: false
 
 # Type Alias: \_ExtractStateFromSetupStore\<SS\>
 
-> **\_ExtractStateFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : [`_ExtractStateFromSetupStore_Keys`](ExtractStateFromSetupStore_Keys.md)\<`SS`\> *extends* keyof `SS` ? [`_UnwrapAll`](UnwrapAll.md)\<`Pick`\<`SS`, [`_ExtractStateFromSetupStore_Keys`](ExtractStateFromSetupStore_Keys.md)\<`SS`\>\>\> : `never`
+> **\_ExtractStateFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractStateFromSetupStore_Keys`](ExtractStateFromSetupStore_Keys.md)\<`SS`\>\>
 
 For internal use **only**