]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
docs: regen api
authorEduardo San Martin Morote <posva13@gmail.com>
Tue, 7 Feb 2023 08:10:20 +0000 (09:10 +0100)
committerEduardo San Martin Morote <posva@users.noreply.github.com>
Wed, 15 Feb 2023 09:52:57 +0000 (10:52 +0100)
25 files changed:
packages/docs/api/enums/pinia.MutationType.md
packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md
packages/docs/api/interfaces/pinia.DefineStoreOptions.md
packages/docs/api/interfaces/pinia.DefineStoreOptionsBase.md
packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md
packages/docs/api/interfaces/pinia.MapStoresCustomization.md
packages/docs/api/interfaces/pinia.Pinia.md
packages/docs/api/interfaces/pinia.PiniaCustomProperties.md
packages/docs/api/interfaces/pinia.PiniaCustomStateProperties.md
packages/docs/api/interfaces/pinia.PiniaPlugin.md
packages/docs/api/interfaces/pinia.PiniaPluginContext.md
packages/docs/api/interfaces/pinia.StoreDefinition.md
packages/docs/api/interfaces/pinia.StoreProperties.md
packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md
packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md
packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md
packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md
packages/docs/api/interfaces/pinia._StoreWithState.md
packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md
packages/docs/api/interfaces/pinia_nuxt.ModuleOptions.md [new file with mode: 0644]
packages/docs/api/interfaces/pinia_testing.TestingOptions.md
packages/docs/api/interfaces/pinia_testing.TestingPinia.md
packages/docs/api/modules/pinia.md
packages/docs/api/modules/pinia_nuxt.md
packages/docs/api/modules/pinia_testing.md

index 7ab721d99f92e65d04f345314e1eb038f826bb83..6c68f38d7fc2b4ab885dadd6e1ca63628f02a432 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MutationType
index e1a17b30e24a3f933269a0bbc91da9bea172f886..a95ef29ac18438f852951adad349115d12d769e7 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineSetupStoreOptions
index ca72b0bfd6c0180e88300b1168ecd14bed232ffc..ba20a033a427953ab6f0fee9e41326fb79badb78 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptions
index f22310692d18aedf484672af7566873d48d60a93..389e56e9bcd6a72606d0bdc5bfe498f343d4264b 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsBase
index 7cd737eb0316e42e59d714b260728325f42a0673..4419636495010f0f6b91c737dd76855ce4a977e5 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsInPlugin
index 4a27117cb60941fe7d844544362ec0d89fb0e9a8..ea24732ad67ca5d877a556a51518c61027c14528 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MapStoresCustomization
index 8118e4b43026f898f9ac66cc180c1cae4573a488..f526af0e7b21f7a20a43b0f648c9511801502118 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / Pinia
index 3982be7e2eb04ccc1925c7bfa64f08354c20fed5..0ba15649326e6ea269e82f0568e238ae81df19a3 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomProperties
index 5970a9023ca005886f70e0db0e794e84be6f7ffc..1c7d8e7d901870df730e8e8f78f398545c64d04c 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomStateProperties
index a9c25b389059dc088e93472aee761716aef1011c..b5adf6f960c633fcc1aafb1134e1611a515af10d 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPlugin
index 9253698505f8a4351ea2489937200f9084a9b7a9..b4b47a02d9b895fca6ebe37163a2147cab925e76 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPluginContext
index 27d013ed7ed6b9574b1b3015f155e003cbbed4be..5f791e0a7b8a52da229fa1fd6cef6b423f065e18 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreDefinition
index 2e7707de145342fd61581eda6df7d13b20a247cd..f0daecf1b23eb3cca7e0d67f7778cd7473c10f3d 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreProperties
index 5aa4fd207eb243ff4e73503bfe3078b05c5e66c4..b87e0f5cbcf2265e89d462756dad994084f0355a 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationDirect
index ddbcc3f6c0cda0d88ca7678ac31357a24ae3ed98..8a9345929bf975a4f4adcab87edbdcaf2cdbdcbb 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchFunction
index f171c7c891f8522efad69c46da7be522d2a342cd..041f0e9718e9cf9856ebde433ba31f103e31c51b 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchObject
index 6be817a10aaaf954d07b9651d38887bee0b8b5b3..47bfa53c2f2d13e629cef58b15415cdaa6d17f0c 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext
index d3b4994b38b5321c5c07eba981efe9a2715f14cf..b851248ed0840ee45817ecf236dd1993a99a2d54 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreWithState
index dd02d2fae61e2dcc094e82659c6a7f3307b0929d..b0cf4d64c7ebea9e7585d4ab9c6801da88af8363 100644 (file)
@@ -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 (file)
index 0000000..fe3e64e
--- /dev/null
@@ -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`
index 4c24d0de48056f76339d0276225190e4cbaa0632..973578bc82d7e08aaf11a24ac1f09cf04b29f9fb 100644 (file)
@@ -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}%
 
index 09b4f61946239be6712cd2d5a5a90c833ecd0297..ae8ebe61425cbdc1eb7df9495891242eeddc793f 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingPinia
index 40b3aca97e9bfd3d39bb0b6bb0b190b2e48d151e..31123e342c59950c0ed41d2b44b91d4b655706e7 100644 (file)
@@ -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>.
+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
index 49e6a9cd3c0ace7d0fd334a8e1637c66b8f0d9ff..678d84aa8355840acfb71a111cc4e55790d51275 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / @pinia/nuxt
index ba6a09f02013bce8a3bf2ec18b26fd2a17daf5ff..94adb3bc21a5ee0ecda07ffa7f82fef23ddd1c8d 100644 (file)
@@ -1,7 +1,5 @@
 ---
-sidebar: "auto"
 editLink: false
-sidebarDepth: 3
 ---
 
 [API Documentation](../index.md) / @pinia/testing