From 688c526148321c5243858482e25af7359d5069b8 Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Mon, 30 Sep 2024 14:56:11 +0200 Subject: [PATCH] docs: updates --- .../docs/api/@pinia/nuxt/functions/default.md | 6 ++-- .../@pinia/testing/interfaces/TestingPinia.md | 2 +- packages/docs/api/pinia/index.md | 28 +++++++++---------- packages/docs/api/pinia/interfaces/Pinia.md | 2 +- .../api/pinia/interfaces/StoreProperties.md | 16 +++++------ .../api/pinia/interfaces/StoreWithState.md | 28 +++++++++---------- .../ExtractStateFromSetupStore.md | 2 +- 7 files changed, 42 insertions(+), 42 deletions(-) diff --git a/packages/docs/api/@pinia/nuxt/functions/default.md b/packages/docs/api/@pinia/nuxt/functions/default.md index 64c5fe3ff5..d7c1376a62 100644 --- a/packages/docs/api/@pinia/nuxt/functions/default.md +++ b/packages/docs/api/@pinia/nuxt/functions/default.md @@ -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` diff --git a/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md b/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md index 1dea5c777b..1e26372edc 100644 --- a/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md +++ b/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md @@ -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 diff --git a/packages/docs/api/pinia/index.md b/packages/docs/api/pinia/index.md index e09ada4308..38339fbe68 100644 --- a/packages/docs/api/pinia/index.md +++ b/packages/docs/api/pinia/index.md @@ -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 diff --git a/packages/docs/api/pinia/interfaces/Pinia.md b/packages/docs/api/pinia/interfaces/Pinia.md index 78153c2807..190c5d066b 100644 --- a/packages/docs/api/pinia/interfaces/Pinia.md +++ b/packages/docs/api/pinia/interfaces/Pinia.md @@ -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 diff --git a/packages/docs/api/pinia/interfaces/StoreProperties.md b/packages/docs/api/pinia/interfaces/StoreProperties.md index 80adff222d..22ca27916e 100644 --- a/packages/docs/api/pinia/interfaces/StoreProperties.md +++ b/packages/docs/api/pinia/interfaces/StoreProperties.md @@ -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 diff --git a/packages/docs/api/pinia/interfaces/StoreWithState.md b/packages/docs/api/pinia/interfaces/StoreWithState.md index d1927d099b..3c03565a3d 100644 --- a/packages/docs/api/pinia/interfaces/StoreWithState.md +++ b/packages/docs/api/pinia/interfaces/StoreWithState.md @@ -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() diff --git a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md index 5cdd0b7b50..91b59ad8fd 100644 --- a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md +++ b/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md @@ -10,7 +10,7 @@ editLink: false # Type Alias: \_ExtractStateFromSetupStore\ -> **\_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**