From: Eduardo San Martin Morote Date: Tue, 7 Feb 2023 08:10:20 +0000 (+0100) Subject: docs: regen api X-Git-Tag: @pinia/nuxt@0.4.7~14 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a76396292fa85c266a94b9db1df4f5aabc4bb10d;p=thirdparty%2Fvuejs%2Fpinia.git docs: regen api --- diff --git a/packages/docs/api/enums/pinia.MutationType.md b/packages/docs/api/enums/pinia.MutationType.md index 7ab721d9..6c68f38d 100644 --- a/packages/docs/api/enums/pinia.MutationType.md +++ b/packages/docs/api/enums/pinia.MutationType.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MutationType diff --git a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md index e1a17b30..a95ef29a 100644 --- a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineSetupStoreOptions diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md index ca72b0bf..ba20a033 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptions diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptionsBase.md b/packages/docs/api/interfaces/pinia.DefineStoreOptionsBase.md index f2231069..389e56e9 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptionsBase.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptionsBase.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsBase diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index 7cd737eb..44196364 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsInPlugin diff --git a/packages/docs/api/interfaces/pinia.MapStoresCustomization.md b/packages/docs/api/interfaces/pinia.MapStoresCustomization.md index 4a27117c..ea24732a 100644 --- a/packages/docs/api/interfaces/pinia.MapStoresCustomization.md +++ b/packages/docs/api/interfaces/pinia.MapStoresCustomization.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MapStoresCustomization diff --git a/packages/docs/api/interfaces/pinia.Pinia.md b/packages/docs/api/interfaces/pinia.Pinia.md index 8118e4b4..f526af0e 100644 --- a/packages/docs/api/interfaces/pinia.Pinia.md +++ b/packages/docs/api/interfaces/pinia.Pinia.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / Pinia diff --git a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md index 3982be7e..0ba15649 100644 --- a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomProperties diff --git a/packages/docs/api/interfaces/pinia.PiniaCustomStateProperties.md b/packages/docs/api/interfaces/pinia.PiniaCustomStateProperties.md index 5970a902..1c7d8e7d 100644 --- a/packages/docs/api/interfaces/pinia.PiniaCustomStateProperties.md +++ b/packages/docs/api/interfaces/pinia.PiniaCustomStateProperties.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomStateProperties diff --git a/packages/docs/api/interfaces/pinia.PiniaPlugin.md b/packages/docs/api/interfaces/pinia.PiniaPlugin.md index a9c25b38..b5adf6f9 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs/api/interfaces/pinia.PiniaPlugin.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPlugin diff --git a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md index 92536985..b4b47a02 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPluginContext diff --git a/packages/docs/api/interfaces/pinia.StoreDefinition.md b/packages/docs/api/interfaces/pinia.StoreDefinition.md index 27d013ed..5f791e0a 100644 --- a/packages/docs/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs/api/interfaces/pinia.StoreDefinition.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreDefinition diff --git a/packages/docs/api/interfaces/pinia.StoreProperties.md b/packages/docs/api/interfaces/pinia.StoreProperties.md index 2e7707de..f0daecf1 100644 --- a/packages/docs/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs/api/interfaces/pinia.StoreProperties.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreProperties diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index 5aa4fd20..b87e0f5c 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationDirect diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index ddbcc3f6..8a934592 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchFunction diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index f171c7c8..041f0e97 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchObject diff --git a/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md b/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md index 6be817a1..47bfa53c 100644 --- a/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md +++ b/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext diff --git a/packages/docs/api/interfaces/pinia._StoreWithState.md b/packages/docs/api/interfaces/pinia._StoreWithState.md index d3b4994b..b851248e 100644 --- a/packages/docs/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs/api/interfaces/pinia._StoreWithState.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreWithState diff --git a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index dd02d2fa..b0cf4d64 100644 --- a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_SubscriptionCallbackMutationBase diff --git a/packages/docs/api/interfaces/pinia_nuxt.ModuleOptions.md b/packages/docs/api/interfaces/pinia_nuxt.ModuleOptions.md new file mode 100644 index 00000000..fe3e64e7 --- /dev/null +++ b/packages/docs/api/interfaces/pinia_nuxt.ModuleOptions.md @@ -0,0 +1,41 @@ +--- +editLink: false +--- + +[API Documentation](../index.md) / [@pinia/nuxt](../modules/pinia_nuxt.md) / ModuleOptions + +# Interface: ModuleOptions + +[@pinia/nuxt](../modules/pinia_nuxt.md).ModuleOptions + +## Properties %{#Properties}% + +### autoImports %{#Properties-autoImports}% + +• `Optional` **autoImports**: (`string` \| [`string`, `string`])[] + +Array of auto imports to be added to the nuxt.config.js file. + +**`Example`** + +```js +autoImports: [ + // automatically import `defineStore` + 'defineStore', + // automatically import `defineStore` as `definePiniaStore` + ['defineStore', 'definePiniaStore', +] +``` + +___ + +### disableVuex %{#Properties-disableVuex}% + +• `Optional` **disableVuex**: `boolean` + +Pinia disables Vuex by default, set this option to `false` to avoid it and +use Pinia alongside Vuex (Nuxt 2 only) + +**`Default`** + +`true` diff --git a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md index 4c24d0de..973578bc 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingOptions @@ -33,7 +31,7 @@ with `jest.fn()` in jest projects or `vi.fn()` in vitest projects. `fn` -▸ (...`args`): `any` +▸ (`...args`): `any` ##### Parameters %{#Properties-createSpy-Type-declaration-Parameters_1}% diff --git a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md index 09b4f619..ae8ebe61 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingPinia diff --git a/packages/docs/api/modules/pinia.md b/packages/docs/api/modules/pinia.md index 40b3aca9..31123e34 100644 --- a/packages/docs/api/modules/pinia.md +++ b/packages/docs/api/modules/pinia.md @@ -1,6 +1,5 @@ --- editLink: false -outline: [2, 3] --- [API Documentation](../index.md) / pinia @@ -455,7 +454,7 @@ ___ #### Type declaration %{#Type-Aliases-\_Method-Type-declaration}% -▸ (...`args`): `any` +▸ (`...args`): `any` Generic type for a function that can infer arguments and return type @@ -552,7 +551,7 @@ For internal use **only** Vue 2 Plugin that must be installed for pinia to work. Note **you don't need this plugin if you are using Nuxt.js**. Use the `buildModule` instead: -. +https://pinia.vuejs.org/ssr/nuxt.html. **`Example`** @@ -972,7 +971,7 @@ ___ ### mapStores %{#Functions-mapStores}% -▸ **mapStores**<`Stores`\>(...`stores`): [`_Spread`](pinia.md#_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 diff --git a/packages/docs/api/modules/pinia_nuxt.md b/packages/docs/api/modules/pinia_nuxt.md index 49e6a9cd..678d84aa 100644 --- a/packages/docs/api/modules/pinia_nuxt.md +++ b/packages/docs/api/modules/pinia_nuxt.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / @pinia/nuxt diff --git a/packages/docs/api/modules/pinia_testing.md b/packages/docs/api/modules/pinia_testing.md index ba6a09f0..94adb3bc 100644 --- a/packages/docs/api/modules/pinia_testing.md +++ b/packages/docs/api/modules/pinia_testing.md @@ -1,7 +1,5 @@ --- -sidebar: "auto" editLink: false -sidebarDepth: 3 --- [API Documentation](../index.md) / @pinia/testing