From d17eb208d0a7d1454550ce16afb1c0ea02a80d0a Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Thu, 14 Apr 2022 19:44:48 +0200 Subject: [PATCH] docs: generated api docs --- packages/docs/api/enums/pinia.MutationType.md | 6 +- packages/docs/api/index.md | 1 + .../pinia.DefineSetupStoreOptions.md | 2 +- .../interfaces/pinia.DefineStoreOptions.md | 10 +- .../pinia.DefineStoreOptionsInPlugin.md | 8 +- packages/docs/api/interfaces/pinia.Pinia.md | 6 +- .../interfaces/pinia.PiniaCustomProperties.md | 22 ++-- .../docs/api/interfaces/pinia.PiniaPlugin.md | 2 +- .../interfaces/pinia.PiniaPluginContext.md | 8 +- .../api/interfaces/pinia.StoreDefinition.md | 4 +- .../api/interfaces/pinia.StoreProperties.md | 4 +- ...inia.SubscriptionCallbackMutationDirect.md | 6 +- ...bscriptionCallbackMutationPatchFunction.md | 6 +- ...SubscriptionCallbackMutationPatchObject.md | 8 +- .../pinia._StoreOnActionListenerContext.md | 106 ++++++++++++++++++ .../api/interfaces/pinia._StoreWithState.md | 18 +-- ...pinia._SubscriptionCallbackMutationBase.md | 4 +- .../interfaces/pinia_nuxt.PiniaNuxtOptions.md | 26 +++++ .../pinia_testing.TestingOptions.md | 12 +- .../interfaces/pinia_testing.TestingPinia.md | 8 +- packages/docs/api/modules/pinia.md | 106 +++++++++--------- packages/docs/api/modules/pinia_nuxt.md | 34 ++++++ packages/docs/api/modules/pinia_testing.md | 2 +- 23 files changed, 288 insertions(+), 121 deletions(-) create mode 100644 packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md create mode 100644 packages/docs/api/interfaces/pinia_nuxt.PiniaNuxtOptions.md create mode 100644 packages/docs/api/modules/pinia_nuxt.md diff --git a/packages/docs/api/enums/pinia.MutationType.md b/packages/docs/api/enums/pinia.MutationType.md index b3590568..a315f0d5 100644 --- a/packages/docs/api/enums/pinia.MutationType.md +++ b/packages/docs/api/enums/pinia.MutationType.md @@ -26,7 +26,7 @@ Direct mutation of the state: #### Defined in -[pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L50) +[packages/pinia/src/types.ts:50](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L50) ___ @@ -40,7 +40,7 @@ Mutated the state with `$patch` and a function #### Defined in -[pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L64) +[packages/pinia/src/types.ts:64](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L64) ___ @@ -54,4 +54,4 @@ Mutated the state with `$patch` and an object #### Defined in -[pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L57) +[packages/pinia/src/types.ts:57](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L57) diff --git a/packages/docs/api/index.md b/packages/docs/api/index.md index fe54079c..f25b0e46 100644 --- a/packages/docs/api/index.md +++ b/packages/docs/api/index.md @@ -4,5 +4,6 @@ API Documentation ## Modules +- [@pinia/nuxt](modules/pinia_nuxt.md) - [@pinia/testing](modules/pinia_testing.md) - [pinia](modules/pinia.md) diff --git a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md index fbe581c4..4c9bf637 100644 --- a/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -40,4 +40,4 @@ store defined with a setup function. Note this is always defined #### Defined in -[pinia/src/types.ts:704](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L704) +[packages/pinia/src/types.ts:704](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L704) diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md index 40c2ccf8..94946e48 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptions.md @@ -38,7 +38,7 @@ Optional object of actions. #### Defined in -[pinia/src/types.ts:652](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L652) +[packages/pinia/src/types.ts:652](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L652) ___ @@ -50,7 +50,7 @@ Optional object of getters. #### Defined in -[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L645) +[packages/pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L645) ___ @@ -62,7 +62,7 @@ Unique string key to identify the store across the application. #### Defined in -[pinia/src/types.ts:634](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L634) +[packages/pinia/src/types.ts:634](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L634) ## Methods @@ -103,7 +103,7 @@ const useStore = defineStore('main', { #### Defined in -[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L685) +[packages/pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L685) ___ @@ -120,4 +120,4 @@ correct typings! #### Defined in -[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L640) +[packages/pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L640) diff --git a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index bb3812f6..52baf801 100644 --- a/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -39,7 +39,7 @@ Defaults to an empty object if no actions are defined. #### Defined in -[pinia/src/types.ts:721](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L721) +[packages/pinia/src/types.ts:721](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L721) ___ @@ -55,7 +55,7 @@ Omit.getters #### Defined in -[pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L645) +[packages/pinia/src/types.ts:645](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L645) ## Methods @@ -100,7 +100,7 @@ Omit.hydrate #### Defined in -[pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L685) +[packages/pinia/src/types.ts:685](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L685) ___ @@ -121,4 +121,4 @@ Omit.state #### Defined in -[pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L640) +[packages/pinia/src/types.ts:640](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L640) diff --git a/packages/docs/api/interfaces/pinia.Pinia.md b/packages/docs/api/interfaces/pinia.Pinia.md index e5f17ef3..776bdee1 100644 --- a/packages/docs/api/interfaces/pinia.Pinia.md +++ b/packages/docs/api/interfaces/pinia.Pinia.md @@ -28,7 +28,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L51) +[packages/pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L51) ## Methods @@ -48,7 +48,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L46) +[packages/pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L46) ___ @@ -70,4 +70,4 @@ Adds a store plugin to extend every store #### Defined in -[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L58) +[packages/pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L58) diff --git a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md index 3f834763..41485f85 100644 --- a/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs/api/interfaces/pinia.PiniaCustomProperties.md @@ -31,7 +31,7 @@ Nuxt context. #### Defined in -[nuxt/src/module.ts:68](https://github.com/vuejs/pinia/blob/6ce186f/packages/nuxt/src/module.ts#L68) +[packages/nuxt/src/module.ts:68](https://github.com/vuejs/pinia/blob/2b998ee/packages/nuxt/src/module.ts#L68) ___ @@ -41,7 +41,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:14](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L14) +[packages/pinia/__tests__/storePlugins.spec.ts:14](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L14) ___ @@ -51,7 +51,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:11](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L11) +[packages/pinia/__tests__/storePlugins.spec.ts:11](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L11) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:12](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L12) +[packages/pinia/__tests__/storePlugins.spec.ts:12](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L12) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:9](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L9) +[packages/pinia/__tests__/storePlugins.spec.ts:9](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L9) ___ @@ -81,7 +81,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:10](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L10) +[packages/pinia/__tests__/storePlugins.spec.ts:10](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L10) ___ @@ -91,7 +91,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:7](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L7) +[packages/pinia/__tests__/storePlugins.spec.ts:7](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L7) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:13](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L13) +[packages/pinia/__tests__/storePlugins.spec.ts:13](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L13) ___ @@ -111,7 +111,7 @@ ___ #### Defined in -[pinia/__tests__/storePlugins.spec.ts:8](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/__tests__/storePlugins.spec.ts#L8) +[packages/pinia/__tests__/storePlugins.spec.ts:8](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/__tests__/storePlugins.spec.ts#L8) ## Accessors @@ -125,7 +125,7 @@ ___ #### Defined in -[playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/6ce186f/packages/playground/src/main.ts#L17) +[packages/playground/src/main.ts:17](https://github.com/vuejs/pinia/blob/2b998ee/packages/playground/src/main.ts#L17) • `set` **route**(`value`): `void` @@ -141,4 +141,4 @@ ___ #### Defined in -[playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/6ce186f/packages/playground/src/main.ts#L14) +[packages/playground/src/main.ts:14](https://github.com/vuejs/pinia/blob/2b998ee/packages/playground/src/main.ts#L14) diff --git a/packages/docs/api/interfaces/pinia.PiniaPlugin.md b/packages/docs/api/interfaces/pinia.PiniaPlugin.md index e1cfa788..b4be4a93 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs/api/interfaces/pinia.PiniaPlugin.md @@ -31,4 +31,4 @@ nothing. #### Defined in -[pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L140) +[packages/pinia/src/rootStore.ts:140](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L140) diff --git a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md index c3fbf1d4..9883731b 100644 --- a/packages/docs/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs/api/interfaces/pinia.PiniaPluginContext.md @@ -31,7 +31,7 @@ Current app created with `Vue.createApp()`. #### Defined in -[pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L117) +[packages/pinia/src/rootStore.ts:117](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L117) ___ @@ -43,7 +43,7 @@ Current store being extended. #### Defined in -[pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L127) +[packages/pinia/src/rootStore.ts:127](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L127) ___ @@ -55,7 +55,7 @@ pinia instance. #### Defined in -[pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L112) +[packages/pinia/src/rootStore.ts:112](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L112) ___ @@ -67,4 +67,4 @@ Current store being extended. #### Defined in -[pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L122) +[packages/pinia/src/rootStore.ts:122](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L122) diff --git a/packages/docs/api/interfaces/pinia.StoreDefinition.md b/packages/docs/api/interfaces/pinia.StoreDefinition.md index 0ca7c3a2..e2657f6b 100644 --- a/packages/docs/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs/api/interfaces/pinia.StoreDefinition.md @@ -40,7 +40,7 @@ Returns a store, creates it if necessary. #### Defined in -[pinia/src/types.ts:511](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L511) +[packages/pinia/src/types.ts:511](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L511) ## Properties @@ -52,4 +52,4 @@ Id of the store. Used by map helpers. #### Defined in -[pinia/src/types.ts:516](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L516) +[packages/pinia/src/types.ts:516](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L516) diff --git a/packages/docs/api/interfaces/pinia.StoreProperties.md b/packages/docs/api/interfaces/pinia.StoreProperties.md index 043c1ca2..9f573e3c 100644 --- a/packages/docs/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs/api/interfaces/pinia.StoreProperties.md @@ -34,7 +34,7 @@ Unique identifier of the store #### Defined in -[pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L265) +[packages/pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L265) ___ @@ -48,4 +48,4 @@ that should be displayed in devtools. #### Defined in -[pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L293) +[packages/pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L293) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index 2225ab40..17fcbcd4 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -30,7 +30,7 @@ DEV ONLY. Different mutation calls. #### Defined in -[pinia/src/types.ts:96](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L96) +[packages/pinia/src/types.ts:96](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L96) ___ @@ -46,7 +46,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L81) +[packages/pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L81) ___ @@ -62,4 +62,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:91](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L91) +[packages/pinia/src/types.ts:91](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L91) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index 7cccfc75..bc79cc5a 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -29,7 +29,7 @@ DEV ONLY. Array of all the mutations done inside of the callback. #### Defined in -[pinia/src/types.ts:129](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L129) +[packages/pinia/src/types.ts:129](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L129) ___ @@ -45,7 +45,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L81) +[packages/pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L81) ___ @@ -61,4 +61,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:124](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L124) +[packages/pinia/src/types.ts:124](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L124) diff --git a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index 64bf01b7..4fc2fa9f 100644 --- a/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -35,7 +35,7 @@ DEV ONLY. Array for patch calls. #### Defined in -[pinia/src/types.ts:110](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L110) +[packages/pinia/src/types.ts:110](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L110) ___ @@ -47,7 +47,7 @@ Object passed to `store.$patch()`. #### Defined in -[pinia/src/types.ts:115](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L115) +[packages/pinia/src/types.ts:115](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L115) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L81) +[packages/pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L81) ___ @@ -79,4 +79,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:105](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L105) +[packages/pinia/src/types.ts:105](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L105) diff --git a/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md b/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md new file mode 100644 index 00000000..236bb754 --- /dev/null +++ b/packages/docs/api/interfaces/pinia._StoreOnActionListenerContext.md @@ -0,0 +1,106 @@ +--- +sidebar: "auto" +editLinks: false +sidebarDepth: 3 +--- + +[API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext + +# Interface: \_StoreOnActionListenerContext + +[pinia](../modules/pinia.md)._StoreOnActionListenerContext + +Actual type for [StoreOnActionListenerContext](../modules/pinia.md#storeonactionlistenercontext). Exists for refactoring +purposes. For internal use only. +For internal use **only** + +## Type parameters + +| Name | Type | +| :------ | :------ | +| `Store` | `Store` | +| `ActionName` | extends `string` | +| `A` | `A` | + +## Properties + +### args + +• **args**: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? `Parameters`<`A`[`ActionName`]\> : `unknown`[] + +Parameters passed to the action + +#### Defined in + +[packages/pinia/src/types.ts:195](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L195) + +___ + +### name + +• **name**: `ActionName` + +Name of the action + +#### Defined in + +[packages/pinia/src/types.ts:185](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L185) + +___ + +### store + +• **store**: `Store` + +Store that is invoking the action + +#### Defined in + +[packages/pinia/src/types.ts:190](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L190) + +## Methods + +### after + +▸ **after**(`callback`): `void` + +Sets up a hook once the action is finished. It receives the return value +of the action, if it's a Promise, it will be unwrapped. Can return a +value (other than `undefined`) to **override** the returned value. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` \| `ReturnType`<`A`[`ActionName`]\> \| [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\> : () => `void` | + +#### Returns + +`void` + +#### Defined in + +[packages/pinia/src/types.ts:204](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L204) + +___ + +### onError + +▸ **onError**(`callback`): `void` + +Sets up a hook if the action fails. Return `false` to catch the error and +stop it fro propagating. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `callback` | (`error`: `unknown`) => `unknown` | + +#### Returns + +`void` + +#### Defined in + +[packages/pinia/src/types.ts:220](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L220) diff --git a/packages/docs/api/interfaces/pinia._StoreWithState.md b/packages/docs/api/interfaces/pinia._StoreWithState.md index 7252af20..6febbb8b 100644 --- a/packages/docs/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs/api/interfaces/pinia._StoreWithState.md @@ -41,7 +41,7 @@ Unique identifier of the store #### Defined in -[pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L265) +[packages/pinia/src/types.ts:265](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L265) ___ @@ -53,7 +53,7 @@ State of the Store. Setting it will replace the whole state. #### Defined in -[pinia/src/types.ts:335](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L335) +[packages/pinia/src/types.ts:335](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L335) ___ @@ -71,7 +71,7 @@ that should be displayed in devtools. #### Defined in -[pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L293) +[packages/pinia/src/types.ts:293](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L293) ## Methods @@ -89,7 +89,7 @@ e.g. devtools plugin stops displaying disposed stores from devtools. #### Defined in -[pinia/src/types.ts:423](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L423) +[packages/pinia/src/types.ts:423](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L423) ___ @@ -182,7 +182,7 @@ function that removes the watcher #### Defined in -[pinia/src/types.ts:413](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L413) +[packages/pinia/src/types.ts:413](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L413) ___ @@ -204,7 +204,7 @@ Applies a state patch to current state. Allows passing nested values #### Defined in -[pinia/src/types.ts:342](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L342) +[packages/pinia/src/types.ts:342](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L342) ▸ **$patch**<`F`\>(`stateMutator`): `void` @@ -230,7 +230,7 @@ to an array. The function passed to `$patch()` **must be synchronous**. #### Defined in -[pinia/src/types.ts:351](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L351) +[packages/pinia/src/types.ts:351](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L351) ___ @@ -247,7 +247,7 @@ TODO: make this options only #### Defined in -[pinia/src/types.ts:360](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L360) +[packages/pinia/src/types.ts:360](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L360) ___ @@ -286,4 +286,4 @@ function that removes the watcher #### Defined in -[pinia/src/types.ts:372](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L372) +[packages/pinia/src/types.ts:372](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L372) diff --git a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index 2b720054..119b8fe9 100644 --- a/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -32,7 +32,7 @@ Base type for the context passed to a subscription callback. Internal type. #### Defined in -[pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L81) +[packages/pinia/src/types.ts:81](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L81) ___ @@ -44,4 +44,4 @@ Type of the mutation. #### Defined in -[pinia/src/types.ts:76](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L76) +[packages/pinia/src/types.ts:76](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L76) diff --git a/packages/docs/api/interfaces/pinia_nuxt.PiniaNuxtOptions.md b/packages/docs/api/interfaces/pinia_nuxt.PiniaNuxtOptions.md new file mode 100644 index 00000000..bcaf7c50 --- /dev/null +++ b/packages/docs/api/interfaces/pinia_nuxt.PiniaNuxtOptions.md @@ -0,0 +1,26 @@ +--- +sidebar: "auto" +editLinks: false +sidebarDepth: 3 +--- + +[API Documentation](../index.md) / [@pinia/nuxt](../modules/pinia_nuxt.md) / PiniaNuxtOptions + +# Interface: PiniaNuxtOptions + +[@pinia/nuxt](../modules/pinia_nuxt.md).PiniaNuxtOptions + +## Properties + +### disableVuex + +• `Optional` **disableVuex**: `boolean` + +Pinia disables Vuex by default, set this option to `false` to avoid it and +use Pinia alongside Vuex. + +**`default`** `true` + +#### Defined in + +[packages/nuxt/src/module.ts:15](https://github.com/vuejs/pinia/blob/2b998ee/packages/nuxt/src/module.ts#L15) diff --git a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md index fad66d47..87040b5f 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md @@ -23,7 +23,7 @@ Defaults to false. #### Defined in -[testing/src/testing.ts:57](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L57) +[packages/testing/src/testing.ts:57](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L57) ___ @@ -36,7 +36,7 @@ allowing you to only set a few properties that are required in your test. #### Defined in -[testing/src/testing.ts:27](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L27) +[packages/testing/src/testing.ts:27](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L27) ___ @@ -49,7 +49,7 @@ your application that will be used while testing. #### Defined in -[testing/src/testing.ts:33](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L33) +[packages/testing/src/testing.ts:33](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L33) ___ @@ -65,7 +65,7 @@ handle this in `createSpy()`. #### Defined in -[testing/src/testing.ts:42](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L42) +[packages/testing/src/testing.ts:42](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L42) ___ @@ -79,7 +79,7 @@ argument `undefined`. You still have to handle this in `createSpy()`. #### Defined in -[testing/src/testing.ts:49](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L49) +[packages/testing/src/testing.ts:49](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L49) ## Methods @@ -114,4 +114,4 @@ with `jest.fn()` in jest projects or `vi.fn()` in vitest projects. #### Defined in -[testing/src/testing.ts:63](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L63) +[packages/testing/src/testing.ts:63](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L63) diff --git a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md index 4b1e555a..4ae65bdb 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingPinia.md @@ -29,7 +29,7 @@ App used by Pinia #### Defined in -[testing/src/testing.ts:72](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L72) +[packages/testing/src/testing.ts:72](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L72) ___ @@ -45,7 +45,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L51) +[packages/pinia/src/rootStore.ts:51](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L51) ## Methods @@ -69,7 +69,7 @@ root state #### Defined in -[pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L46) +[packages/pinia/src/rootStore.ts:46](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L46) ___ @@ -95,4 +95,4 @@ Adds a store plugin to extend every store #### Defined in -[pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L58) +[packages/pinia/src/rootStore.ts:58](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L58) diff --git a/packages/docs/api/modules/pinia.md b/packages/docs/api/modules/pinia.md index 0ef78d41..363bcb98 100644 --- a/packages/docs/api/modules/pinia.md +++ b/packages/docs/api/modules/pinia.md @@ -45,7 +45,7 @@ Plugin to extend every store. #### Defined in -[pinia/src/rootStore.ts:149](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L149) +[packages/pinia/src/rootStore.ts:149](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L149) ___ @@ -57,7 +57,7 @@ Generic state of a Store #### Defined in -[pinia/src/types.ts:13](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L13) +[packages/pinia/src/types.ts:13](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L13) ___ @@ -78,7 +78,7 @@ Store type to build a store. #### Defined in -[pinia/src/types.ts:470](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L470) +[packages/pinia/src/types.ts:470](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L470) ___ @@ -97,7 +97,7 @@ Options Store. #### Defined in -[pinia/src/store.ts:729](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L729) +[packages/pinia/src/store.ts:729](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L729) ___ @@ -111,7 +111,7 @@ about the kind of store that is passed. #### Defined in -[pinia/src/types.ts:489](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L489) +[packages/pinia/src/types.ts:489](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L489) ___ @@ -130,7 +130,7 @@ Options Store. #### Defined in -[pinia/src/store.ts:742](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L742) +[packages/pinia/src/store.ts:742](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L742) ___ @@ -165,7 +165,7 @@ Argument of `store.$onAction()` #### Defined in -[pinia/src/types.ts:243](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L243) +[packages/pinia/src/types.ts:243](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L243) ___ @@ -187,7 +187,7 @@ TODO: should have only the Id, the Store and Actions to generate the proper obje #### Defined in -[pinia/src/types.ts:227](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L227) +[packages/pinia/src/types.ts:227](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L227) ___ @@ -206,7 +206,7 @@ Options Store. Note this unwraps refs. #### Defined in -[pinia/src/store.ts:755](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L755) +[packages/pinia/src/store.ts:755](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L755) ___ @@ -239,7 +239,7 @@ Callback of a subscription #### Defined in -[pinia/src/types.ts:148](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L148) +[packages/pinia/src/types.ts:148](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L148) ___ @@ -257,7 +257,7 @@ Context object passed to a subscription callback. #### Defined in -[pinia/src/types.ts:140](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L140) +[packages/pinia/src/types.ts:140](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L140) ___ @@ -270,7 +270,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:555](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L555) +[packages/pinia/src/types.ts:555](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L555) ___ @@ -286,7 +286,7 @@ ___ #### Defined in -[pinia/src/types.ts:164](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L164) +[packages/pinia/src/types.ts:164](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L164) ___ @@ -306,7 +306,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:35](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L35) +[packages/pinia/src/types.ts:35](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L35) ___ @@ -324,7 +324,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:599](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L599) +[packages/pinia/src/types.ts:599](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L599) ___ @@ -343,7 +343,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:569](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L569) +[packages/pinia/src/types.ts:569](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L569) ___ @@ -361,7 +361,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:608](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L608) +[packages/pinia/src/types.ts:608](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L608) ___ @@ -380,7 +380,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:577](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L577) +[packages/pinia/src/types.ts:577](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L577) ___ @@ -398,7 +398,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:590](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L590) +[packages/pinia/src/types.ts:590](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L590) ___ @@ -417,7 +417,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:561](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L561) +[packages/pinia/src/types.ts:561](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L561) ___ @@ -436,7 +436,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:545](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L545) +[packages/pinia/src/types.ts:545](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L545) ___ @@ -455,7 +455,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:297](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L297) +[packages/pinia/src/mapHelpers.ts:297](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L297) ___ @@ -473,7 +473,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:290](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L290) +[packages/pinia/src/mapHelpers.ts:290](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L290) ___ @@ -495,7 +495,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:141](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L141) +[packages/pinia/src/mapHelpers.ts:141](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L141) ___ @@ -515,7 +515,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:125](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L125) +[packages/pinia/src/mapHelpers.ts:125](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L125) ___ @@ -534,7 +534,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:422](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L422) +[packages/pinia/src/mapHelpers.ts:422](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L422) ___ @@ -552,7 +552,7 @@ For internal use **only** #### Defined in -[pinia/src/mapHelpers.ts:412](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L412) +[packages/pinia/src/mapHelpers.ts:412](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L412) ___ @@ -580,7 +580,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:439](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L439) +[packages/pinia/src/types.ts:439](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L439) ___ @@ -598,7 +598,7 @@ For internal use **only**. #### Defined in -[pinia/src/mapHelpers.ts:53](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L53) +[packages/pinia/src/mapHelpers.ts:53](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L53) ___ @@ -616,7 +616,7 @@ For internal use **only**. #### Defined in -[pinia/src/mapHelpers.ts:25](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L25) +[packages/pinia/src/mapHelpers.ts:25](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L25) ___ @@ -635,7 +635,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:451](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L451) +[packages/pinia/src/types.ts:451](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L451) ___ @@ -654,7 +654,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:461](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L461) +[packages/pinia/src/types.ts:461](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L461) ___ @@ -673,7 +673,7 @@ For internal use **only** #### Defined in -[pinia/src/types.ts:585](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/types.ts#L585) +[packages/pinia/src/types.ts:585](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/types.ts#L585) ## Variables @@ -704,7 +704,7 @@ new Vue({ #### Defined in -[pinia/src/vue2-plugin.ts:28](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/vue2-plugin.ts#L28) +[packages/pinia/src/vue2-plugin.ts:28](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/vue2-plugin.ts#L28) ## Functions @@ -747,7 +747,7 @@ if (import.meta.hot) { #### Defined in -[pinia/src/hmr.ts:73](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/hmr.ts#L73) +[packages/pinia/src/hmr.ts:73](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/hmr.ts#L73) ___ @@ -763,7 +763,7 @@ Creates a Pinia instance to be used by the application #### Defined in -[pinia/src/createPinia.ts:10](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/createPinia.ts#L10) +[packages/pinia/src/createPinia.ts:10](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/createPinia.ts#L10) ___ @@ -795,7 +795,7 @@ Creates a `useStore` function that retrieves the store instance #### Defined in -[pinia/src/store.ts:778](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L778) +[packages/pinia/src/store.ts:778](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L778) ▸ **defineStore**<`Id`, `S`, `G`, `A`\>(`options`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -822,7 +822,7 @@ Creates a `useStore` function that retrieves the store instance #### Defined in -[pinia/src/store.ts:794](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L794) +[packages/pinia/src/store.ts:794](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L794) ▸ **defineStore**<`Id`, `SS`\>(`id`, `storeSetup`, `options?`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> @@ -849,7 +849,7 @@ Creates a `useStore` function that retrieves the store instance #### Defined in -[pinia/src/store.ts:809](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L809) +[packages/pinia/src/store.ts:809](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L809) ___ @@ -865,7 +865,7 @@ Get the currently active pinia if there is any. #### Defined in -[pinia/src/rootStore.ts:39](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L39) +[packages/pinia/src/rootStore.ts:39](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L39) ___ @@ -917,7 +917,7 @@ export default { #### Defined in -[pinia/src/mapHelpers.ts:326](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L326) +[packages/pinia/src/mapHelpers.ts:326](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L326) ▸ **mapActions**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> @@ -962,7 +962,7 @@ export default { #### Defined in -[pinia/src/mapHelpers.ts:359](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L359) +[packages/pinia/src/mapHelpers.ts:359](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L359) ___ @@ -997,7 +997,7 @@ Alias for `mapState()`. You should use `mapState()` instead. #### Defined in -[pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L285) +[packages/pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L285) ▸ **mapGetters**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> @@ -1028,7 +1028,7 @@ Alias for `mapState()`. You should use `mapState()` instead. #### Defined in -[pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L285) +[packages/pinia/src/mapHelpers.ts:285](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L285) ___ @@ -1091,7 +1091,7 @@ export default { #### Defined in -[pinia/src/mapHelpers.ts:194](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L194) +[packages/pinia/src/mapHelpers.ts:194](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L194) ▸ **mapState**<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> @@ -1137,7 +1137,7 @@ export default { #### Defined in -[pinia/src/mapHelpers.ts:231](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L231) +[packages/pinia/src/mapHelpers.ts:231](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L231) ___ @@ -1182,7 +1182,7 @@ export default { #### Defined in -[pinia/src/mapHelpers.ts:96](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L96) +[packages/pinia/src/mapHelpers.ts:96](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L96) ___ @@ -1217,7 +1217,7 @@ added. #### Defined in -[pinia/src/mapHelpers.ts:440](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L440) +[packages/pinia/src/mapHelpers.ts:440](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L440) ▸ **mapWritableState**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> @@ -1247,7 +1247,7 @@ of a component. #### Defined in -[pinia/src/mapHelpers.ts:458](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L458) +[packages/pinia/src/mapHelpers.ts:458](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L458) ___ @@ -1270,7 +1270,7 @@ actions and getters #### Defined in -[pinia/src/rootStore.ts:33](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/rootStore.ts#L33) +[packages/pinia/src/rootStore.ts:33](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/rootStore.ts#L33) ___ @@ -1294,7 +1294,7 @@ interface if you need are using TypeScript. #### Defined in -[pinia/src/mapHelpers.ts:66](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/mapHelpers.ts#L66) +[packages/pinia/src/mapHelpers.ts:66](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/mapHelpers.ts#L66) ___ @@ -1320,7 +1320,7 @@ ___ #### Defined in -[pinia/src/store.ts:87](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/store.ts#L87) +[packages/pinia/src/store.ts:87](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/store.ts#L87) ___ @@ -1351,4 +1351,4 @@ completely ignored. #### Defined in -[pinia/src/storeToRefs.ts:21](https://github.com/vuejs/pinia/blob/6ce186f/packages/pinia/src/storeToRefs.ts#L21) +[packages/pinia/src/storeToRefs.ts:21](https://github.com/vuejs/pinia/blob/2b998ee/packages/pinia/src/storeToRefs.ts#L21) diff --git a/packages/docs/api/modules/pinia_nuxt.md b/packages/docs/api/modules/pinia_nuxt.md new file mode 100644 index 00000000..9a7ec555 --- /dev/null +++ b/packages/docs/api/modules/pinia_nuxt.md @@ -0,0 +1,34 @@ +--- +sidebar: "auto" +editLinks: false +sidebarDepth: 3 +--- + +[API Documentation](../index.md) / @pinia/nuxt + +# Module: @pinia/nuxt + +## Interfaces + +- [PiniaNuxtOptions](../interfaces/pinia_nuxt.PiniaNuxtOptions.md) + +## Functions + +### default + +▸ **default**(`this`, `moduleOptions`): `void` \| `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `this` | `ModuleThis` | +| `moduleOptions` | `any` | + +#### Returns + +`void` \| `Promise`<`void`\> + +#### Defined in + +node_modules/.pnpm/@nuxt+types@2.15.8/node_modules/@nuxt/types/config/module.d.ts:29 diff --git a/packages/docs/api/modules/pinia_testing.md b/packages/docs/api/modules/pinia_testing.md index 3921e6cf..7399b71a 100644 --- a/packages/docs/api/modules/pinia_testing.md +++ b/packages/docs/api/modules/pinia_testing.md @@ -40,4 +40,4 @@ a augmented pinia instance #### Defined in -[testing/src/testing.ts:92](https://github.com/vuejs/pinia/blob/6ce186f/packages/testing/src/testing.ts#L92) +[packages/testing/src/testing.ts:92](https://github.com/vuejs/pinia/blob/2b998ee/packages/testing/src/testing.ts#L92) -- 2.47.2