From: Eduardo San Martin Morote Date: Wed, 11 Jan 2023 14:34:03 +0000 (+0100) Subject: docs(fix): api headers X-Git-Tag: @pinia/nuxt@0.4.7~32 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=db7217cbc11d0d8d35f568c53c3df7c6e13989c9;p=thirdparty%2Fvuejs%2Fpinia.git docs(fix): api headers --- diff --git a/packages/docs-new/.vitepress/config/shared.ts b/packages/docs-new/.vitepress/config/shared.ts index 514837f5..a973cded 100644 --- a/packages/docs-new/.vitepress/config/shared.ts +++ b/packages/docs-new/.vitepress/config/shared.ts @@ -87,6 +87,7 @@ export const sharedConfig = defineConfig({ themeConfig: { logo: '/logo.svg', + outline: [2, 3], socialLinks: [ { icon: 'twitter', link: 'https://twitter.com/posva' }, diff --git a/packages/docs-new/.vitepress/config/zh.ts b/packages/docs-new/.vitepress/config/zh.ts index 88837575..94bf820b 100644 --- a/packages/docs-new/.vitepress/config/zh.ts +++ b/packages/docs-new/.vitepress/config/zh.ts @@ -18,11 +18,12 @@ export const zhConfig: LocaleSpecificConfig = { themeConfig: { editLink: { - // TODO: do we need the /zh/ pattern: 'https://github.com/vuejs/pinia/edit/v2/packages/docs/:path', text: '对本页提出修改建议', }, + outlineTitle: '本页内容', + nav: [ // { text: 'Config', link: '/config/' }, // { text: 'Plugins', link: '/plugins/' }, diff --git a/packages/docs-new/api/enums/pinia.MutationType.md b/packages/docs-new/api/enums/pinia.MutationType.md index 031c580e..7ab721d9 100644 --- a/packages/docs-new/api/enums/pinia.MutationType.md +++ b/packages/docs-new/api/enums/pinia.MutationType.md @@ -1,20 +1,20 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MutationType -# Enumeration: MutationType %{#Enumeration:-MutationType}% +# Enumeration: MutationType [pinia](../modules/pinia.md).MutationType Possible types for SubscriptionCallback -## Enumeration Members %{#Enumeration:-MutationType-Enumeration-Members}% +## Enumeration Members %{#Enumeration-Members}% -### direct %{#Enumeration:-MutationType-Enumeration-Members-direct}% +### direct %{#Enumeration-Members-direct}% • **direct** = ``"direct"`` @@ -26,7 +26,7 @@ Direct mutation of the state: ___ -### patchFunction %{#Enumeration:-MutationType-Enumeration-Members-patchFunction}% +### patchFunction %{#Enumeration-Members-patchFunction}% • **patchFunction** = ``"patch function"`` @@ -36,7 +36,7 @@ Mutated the state with `$patch` and a function ___ -### patchObject %{#Enumeration:-MutationType-Enumeration-Members-patchObject}% +### patchObject %{#Enumeration-Members-patchObject}% • **patchObject** = ``"patch object"`` diff --git a/packages/docs-new/api/index.md b/packages/docs-new/api/index.md index 3b28f10b..e331e7e9 100644 --- a/packages/docs-new/api/index.md +++ b/packages/docs-new/api/index.md @@ -1,8 +1,8 @@ API Documentation -# API Documentation %{#API-Documentation}% +# API Documentation -## Modules %{#API-Documentation-Modules}% +## Modules %{#Modules}% - [@pinia/nuxt](modules/pinia_nuxt.md) - [@pinia/testing](modules/pinia_testing.md) diff --git a/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md b/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md index 56e17275..e1a17b30 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md +++ b/packages/docs-new/api/interfaces/pinia.DefineSetupStoreOptions.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineSetupStoreOptions -# Interface: DefineSetupStoreOptions %{#Interface:-DefineSetupStoreOptions}% +# Interface: DefineSetupStoreOptions [pinia](../modules/pinia.md).DefineSetupStoreOptions @@ -17,7 +17,7 @@ augment stores with the plugin API. [DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md). -## Type parameters %{#Interface:-DefineSetupStoreOptions-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -26,15 +26,15 @@ augment stores with the plugin API. | `G` | `G` | | `A` | `A` | -## Hierarchy %{#Interface:-DefineSetupStoreOptions-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\> ↳ **`DefineSetupStoreOptions`** -## Properties %{#Interface:-DefineSetupStoreOptions-Properties}% +## Properties %{#Properties}% -### actions %{#Interface:-DefineSetupStoreOptions-Properties-actions}% +### actions %{#Properties-actions}% • `Optional` **actions**: `A` diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md index 77a42daa..ca72b0bf 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptions.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptions -# Interface: DefineStoreOptions %{#Interface:-DefineStoreOptions}% +# Interface: DefineStoreOptions [pinia](../modules/pinia.md).DefineStoreOptions @@ -17,7 +17,7 @@ augment stores with the plugin API. [DefineStoreOptionsBase](pinia.DefineStoreOptionsBase.md). -## Type parameters %{#Interface:-DefineStoreOptions-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -26,15 +26,15 @@ augment stores with the plugin API. | `G` | `G` | | `A` | `A` | -## Hierarchy %{#Interface:-DefineStoreOptions-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`DefineStoreOptionsBase`](pinia.DefineStoreOptionsBase.md)<`S`, [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\>\> ↳ **`DefineStoreOptions`** -## Properties %{#Interface:-DefineStoreOptions-Properties}% +## Properties %{#Properties}% -### actions %{#Interface:-DefineStoreOptions-Properties-actions}% +### actions %{#Properties-actions}% • `Optional` **actions**: `A` & `ThisType`<`A` & `UnwrapRef`<`S`\> & [`_StoreWithState`](pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\> @@ -42,7 +42,7 @@ Optional object of actions. ___ -### getters %{#Interface:-DefineStoreOptions-Properties-getters}% +### getters %{#Properties-getters}% • `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\> & [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> @@ -50,7 +50,7 @@ Optional object of getters. ___ -### id %{#Interface:-DefineStoreOptions-Properties-id}% +### id %{#Properties-id}% • **id**: `Id` @@ -58,24 +58,24 @@ Unique string key to identify the store across the application. ___ -### state %{#Interface:-DefineStoreOptions-Properties-state}% +### state %{#Properties-state}% • `Optional` **state**: () => `S` -#### Type declaration %{#Interface:-DefineStoreOptions-Properties-state-Type-declaration}% +#### Type declaration %{#Properties-state-Type-declaration}% ▸ (): `S` Function to create a fresh state. **Must be an arrow function** to ensure correct typings! -##### Returns %{#Interface:-DefineStoreOptions-Properties-state-Type-declaration-Returns}% +##### Returns %{#Properties-state-Type-declaration-Returns}% `S` -## Methods %{#Interface:-DefineStoreOptions-Methods}% +## Methods %{#Methods}% -### hydrate %{#Interface:-DefineStoreOptions-Methods-hydrate}% +### hydrate %{#Methods-hydrate}% ▸ `Optional` **hydrate**(`storeState`, `initialState`): `void` @@ -100,13 +100,13 @@ const useStore = defineStore('main', { }) ``` -#### Parameters %{#Interface:-DefineStoreOptions-Methods-hydrate-Parameters}% +#### Parameters %{#Methods-hydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### Returns %{#Interface:-DefineStoreOptions-Methods-hydrate-Returns}% +#### Returns %{#Methods-hydrate-Returns}% `void` diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md index 9f9e1784..f2231069 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsBase.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsBase -# Interface: DefineStoreOptionsBase %{#Interface:-DefineStoreOptionsBase}% +# Interface: DefineStoreOptionsBase [pinia](../modules/pinia.md).DefineStoreOptionsBase @@ -14,14 +14,14 @@ Options passed to `defineStore()` that are common between option and setup stores. Extend this interface if you want to add custom options to both kinds of stores. -## Type parameters %{#Interface:-DefineStoreOptionsBase-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | | `S` | extends [`StateTree`](../modules/pinia.md#statetree) | | `Store` | `Store` | -## Hierarchy %{#Interface:-DefineStoreOptionsBase-Hierarchy}% +## Hierarchy %{#Hierarchy}% - **`DefineStoreOptionsBase`** diff --git a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md index 8dbd58eb..7cd737eb 100644 --- a/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md +++ b/packages/docs-new/api/interfaces/pinia.DefineStoreOptionsInPlugin.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / DefineStoreOptionsInPlugin -# Interface: DefineStoreOptionsInPlugin %{#Interface:-DefineStoreOptionsInPlugin}% +# Interface: DefineStoreOptionsInPlugin [pinia](../modules/pinia.md).DefineStoreOptionsInPlugin Available `options` when creating a pinia plugin. -## Type parameters %{#Interface:-DefineStoreOptionsInPlugin-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,15 +21,15 @@ Available `options` when creating a pinia plugin. | `G` | `G` | | `A` | `A` | -## Hierarchy %{#Interface:-DefineStoreOptionsInPlugin-Hierarchy}% +## Hierarchy %{#Hierarchy}% - `Omit`<[`DefineStoreOptions`](pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\>, ``"id"`` \| ``"actions"``\> ↳ **`DefineStoreOptionsInPlugin`** -## Properties %{#Interface:-DefineStoreOptionsInPlugin-Properties}% +## Properties %{#Properties}% -### actions %{#Interface:-DefineStoreOptionsInPlugin-Properties-actions}% +### actions %{#Properties-actions}% • **actions**: `A` @@ -39,40 +39,40 @@ Defaults to an empty object if no actions are defined. ___ -### getters %{#Interface:-DefineStoreOptionsInPlugin-Properties-getters}% +### getters %{#Properties-getters}% • `Optional` **getters**: `G` & `ThisType`<`UnwrapRef`<`S`\> & [`_StoreWithGetters`](../modules/pinia.md#_storewithgetters)<`G`\> & [`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\>\> & [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> Optional object of getters. -#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Properties-getters-Inherited-from}% +#### Inherited from %{#Properties-getters-Inherited-from}% Omit.getters ___ -### state %{#Interface:-DefineStoreOptionsInPlugin-Properties-state}% +### state %{#Properties-state}% • `Optional` **state**: () => `S` -#### Type declaration %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Type-declaration}% +#### Type declaration %{#Properties-state-Type-declaration}% ▸ (): `S` Function to create a fresh state. **Must be an arrow function** to ensure correct typings! -##### Returns %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Type-declaration-Returns}% +##### Returns %{#Properties-state-Type-declaration-Returns}% `S` -#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Properties-state-Inherited-from}% +#### Inherited from %{#Properties-state-Inherited-from}% Omit.state -## Methods %{#Interface:-DefineStoreOptionsInPlugin-Methods}% +## Methods %{#Methods}% -### hydrate %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate}% +### hydrate %{#Methods-hydrate}% ▸ `Optional` **hydrate**(`storeState`, `initialState`): `void` @@ -97,17 +97,17 @@ const useStore = defineStore('main', { }) ``` -#### Parameters %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Parameters}% +#### Parameters %{#Methods-hydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `storeState` | `UnwrapRef`<`S`\> | the current state in the store | | `initialState` | `UnwrapRef`<`S`\> | initialState | -#### Returns %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Returns}% +#### Returns %{#Methods-hydrate-Returns}% `void` -#### Inherited from %{#Interface:-DefineStoreOptionsInPlugin-Methods-hydrate-Inherited-from}% +#### Inherited from %{#Methods-hydrate-Inherited-from}% Omit.hydrate diff --git a/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md b/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md index 53fbfecc..4a27117c 100644 --- a/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md +++ b/packages/docs-new/api/interfaces/pinia.MapStoresCustomization.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / MapStoresCustomization -# Interface: MapStoresCustomization %{#Interface:-MapStoresCustomization}% +# Interface: MapStoresCustomization [pinia](../modules/pinia.md).MapStoresCustomization diff --git a/packages/docs-new/api/interfaces/pinia.Pinia.md b/packages/docs-new/api/interfaces/pinia.Pinia.md index 79a2ba58..8118e4b4 100644 --- a/packages/docs-new/api/interfaces/pinia.Pinia.md +++ b/packages/docs-new/api/interfaces/pinia.Pinia.md @@ -1,65 +1,65 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / Pinia -# Interface: Pinia %{#Interface:-Pinia}% +# Interface: Pinia [pinia](../modules/pinia.md).Pinia Every application must own its own pinia to be able to create stores -## Hierarchy %{#Interface:-Pinia-Hierarchy}% +## Hierarchy %{#Hierarchy}% - **`Pinia`** ↳ [`TestingPinia`](pinia_testing.TestingPinia.md) -## Properties %{#Interface:-Pinia-Properties}% +## Properties %{#Properties}% -### install %{#Interface:-Pinia-Properties-install}% +### install %{#Properties-install}% • **install**: (`app`: `App`<`any`\>) => `void` -#### Type declaration %{#Interface:-Pinia-Properties-install-Type-declaration}% +#### Type declaration %{#Properties-install-Type-declaration}% ▸ (`app`): `void` -##### Parameters %{#Interface:-Pinia-Properties-install-Type-declaration-Parameters}% +##### Parameters %{#Properties-install-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `app` | `App`<`any`\> | -##### Returns %{#Interface:-Pinia-Properties-install-Type-declaration-Returns}% +##### Returns %{#Properties-install-Type-declaration-Returns}% `void` ___ -### state %{#Interface:-Pinia-Properties-state}% +### state %{#Properties-state}% • **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\> root state -## Methods %{#Interface:-Pinia-Methods}% +## Methods %{#Methods}% -### use %{#Interface:-Pinia-Methods-use}% +### use %{#Methods-use}% ▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md) Adds a store plugin to extend every store -#### Parameters %{#Interface:-Pinia-Methods-use-Parameters}% +#### Parameters %{#Methods-use-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### Returns %{#Interface:-Pinia-Methods-use-Returns}% +#### Returns %{#Methods-use-Returns}% [`Pinia`](pinia.Pinia.md) diff --git a/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md b/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md index 76979fe3..3982be7e 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaCustomProperties.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomProperties -# Interface: PiniaCustomProperties %{#Interface:-PiniaCustomProperties}% +# Interface: PiniaCustomProperties [pinia](../modules/pinia.md).PiniaCustomProperties Interface to be extended by the user when they add properties through plugins. -## Type parameters %{#Interface:-PiniaCustomProperties-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,24 +21,24 @@ Interface to be extended by the user when they add properties through plugins. | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Accessors %{#Interface:-PiniaCustomProperties-Accessors}% +## Accessors %{#Accessors}% -### route %{#Interface:-PiniaCustomProperties-Accessors-route}% +### route %{#Accessors-route}% • `get` **route**(): `RouteLocationNormalized` -#### Returns %{#Interface:-PiniaCustomProperties-Accessors-route-Returns}% +#### Returns %{#Accessors-route-Returns}% `RouteLocationNormalized` • `set` **route**(`value`): `void` -#### Parameters %{#Interface:-PiniaCustomProperties-Accessors-route-Parameters}% +#### Parameters %{#Accessors-route-Parameters}% | Name | Type | | :------ | :------ | | `value` | `RouteLocationNormalizedLoaded` \| `Ref`<`RouteLocationNormalizedLoaded`\> | -#### Returns %{#Interface:-PiniaCustomProperties-Accessors-route-Returns_1}% +#### Returns %{#Accessors-route-Returns_1}% `void` diff --git a/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md b/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md index 4c79e446..5970a902 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaCustomStateProperties.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaCustomStateProperties -# Interface: PiniaCustomStateProperties %{#Interface:-PiniaCustomStateProperties}% +# Interface: PiniaCustomStateProperties [pinia](../modules/pinia.md).PiniaCustomStateProperties Properties that are added to every `store.$state` by `pinia.use()`. -## Type parameters %{#Interface:-PiniaCustomStateProperties-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | diff --git a/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md b/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md index af272b08..a9c25b38 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaPlugin.md @@ -1,30 +1,30 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPlugin -# Interface: PiniaPlugin %{#Interface:-PiniaPlugin}% +# Interface: PiniaPlugin [pinia](../modules/pinia.md).PiniaPlugin -## Callable %{#Interface:-PiniaPlugin-Callable}% +## Callable %{#Callable}% -### PiniaPlugin %{#Interface:-PiniaPlugin-Callable-PiniaPlugin}% +### PiniaPlugin %{#Callable-PiniaPlugin}% ▸ **PiniaPlugin**(`context`): `void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<[`StateTree`](../modules/pinia.md#statetree)\>\> Plugin to extend every store. Returns an object to extend the store or nothing. -#### Parameters %{#Interface:-PiniaPlugin-Callable-PiniaPlugin-Parameters}% +#### Parameters %{#Callable-PiniaPlugin-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `context` | [`PiniaPluginContext`](pinia.PiniaPluginContext.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> | Context | -#### Returns %{#Interface:-PiniaPlugin-Callable-PiniaPlugin-Returns}% +#### Returns %{#Callable-PiniaPlugin-Returns}% `void` \| `Partial`<[`PiniaCustomProperties`](pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](../modules/pinia.md#statetree), [`_GettersTree`](../modules/pinia.md#_getterstree)<[`StateTree`](../modules/pinia.md#statetree)\>, [`_ActionsTree`](../modules/pinia.md#_actionstree)\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<[`StateTree`](../modules/pinia.md#statetree)\>\> diff --git a/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md b/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md index abfe2f67..92536985 100644 --- a/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md +++ b/packages/docs-new/api/interfaces/pinia.PiniaPluginContext.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / PiniaPluginContext -# Interface: PiniaPluginContext %{#Interface:-PiniaPluginContext}% +# Interface: PiniaPluginContext [pinia](../modules/pinia.md).PiniaPluginContext Context argument passed to Pinia plugins. -## Type parameters %{#Interface:-PiniaPluginContext-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,9 +21,9 @@ Context argument passed to Pinia plugins. | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Properties %{#Interface:-PiniaPluginContext-Properties}% +## Properties %{#Properties}% -### app %{#Interface:-PiniaPluginContext-Properties-app}% +### app %{#Properties-app}% • **app**: `App`<`any`\> @@ -31,7 +31,7 @@ Current app created with `Vue.createApp()`. ___ -### options %{#Interface:-PiniaPluginContext-Properties-options}% +### options %{#Properties-options}% • **options**: [`DefineStoreOptionsInPlugin`](pinia.DefineStoreOptionsInPlugin.md)<`Id`, `S`, `G`, `A`\> @@ -39,7 +39,7 @@ Initial options defining the store when calling `defineStore()`. ___ -### pinia %{#Interface:-PiniaPluginContext-Properties-pinia}% +### pinia %{#Properties-pinia}% • **pinia**: [`Pinia`](pinia.Pinia.md) @@ -47,7 +47,7 @@ pinia instance. ___ -### store %{#Interface:-PiniaPluginContext-Properties-store}% +### store %{#Properties-store}% • **store**: [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> diff --git a/packages/docs-new/api/interfaces/pinia.StoreDefinition.md b/packages/docs-new/api/interfaces/pinia.StoreDefinition.md index 8d98e624..27d013ed 100644 --- a/packages/docs-new/api/interfaces/pinia.StoreDefinition.md +++ b/packages/docs-new/api/interfaces/pinia.StoreDefinition.md @@ -1,16 +1,16 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreDefinition -# Interface: StoreDefinition %{#Interface:-StoreDefinition}% +# Interface: StoreDefinition [pinia](../modules/pinia.md).StoreDefinition -## Type parameters %{#Interface:-StoreDefinition-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -19,28 +19,28 @@ sidebarDepth: 3 | `G` | [`_GettersTree`](../modules/pinia.md#_getterstree)<`S`\> | | `A` | [`_ActionsTree`](../modules/pinia.md#_actionstree) | -## Callable %{#Interface:-StoreDefinition-Callable}% +## Callable %{#Callable}% -### StoreDefinition %{#Interface:-StoreDefinition-Callable-StoreDefinition}% +### StoreDefinition %{#Callable-StoreDefinition}% ▸ **StoreDefinition**(`pinia?`, `hot?`): [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> Returns a store, creates it if necessary. -#### Parameters %{#Interface:-StoreDefinition-Callable-StoreDefinition-Parameters}% +#### Parameters %{#Callable-StoreDefinition-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `pinia?` | ``null`` \| [`Pinia`](pinia.Pinia.md) | Pinia instance to retrieve the store | | `hot?` | [`StoreGeneric`](../modules/pinia.md#storegeneric) | dev only hot module replacement | -#### Returns %{#Interface:-StoreDefinition-Callable-StoreDefinition-Returns}% +#### Returns %{#Callable-StoreDefinition-Returns}% [`Store`](../modules/pinia.md#store)<`Id`, `S`, `G`, `A`\> -## Properties %{#Interface:-StoreDefinition-Properties}% +## Properties %{#Properties}% -### $id %{#Interface:-StoreDefinition-Properties-$id}% +### $id %{#Properties-$id}% • **$id**: `Id` diff --git a/packages/docs-new/api/interfaces/pinia.StoreProperties.md b/packages/docs-new/api/interfaces/pinia.StoreProperties.md index 42a1f6ab..2e7707de 100644 --- a/packages/docs-new/api/interfaces/pinia.StoreProperties.md +++ b/packages/docs-new/api/interfaces/pinia.StoreProperties.md @@ -1,32 +1,32 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / StoreProperties -# Interface: StoreProperties %{#Interface:-StoreProperties}% +# Interface: StoreProperties [pinia](../modules/pinia.md).StoreProperties Properties of a store. -## Type parameters %{#Interface:-StoreProperties-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | | `Id` | extends `string` | -## Hierarchy %{#Interface:-StoreProperties-Hierarchy}% +## Hierarchy %{#Hierarchy}% - **`StoreProperties`** ↳ [`_StoreWithState`](pinia._StoreWithState.md) -## Properties %{#Interface:-StoreProperties-Properties}% +## Properties %{#Properties}% -### $id %{#Interface:-StoreProperties-Properties-$id}% +### $id %{#Properties-$id}% • **$id**: `Id` @@ -34,7 +34,7 @@ Unique identifier of the store ___ -### \_customProperties %{#Interface:-StoreProperties-Properties-\_customProperties}% +### \_customProperties %{#Properties-\_customProperties}% • **\_customProperties**: `Set`<`string`\> diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md index 0045422e..5aa4fd20 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationDirect.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationDirect -# Interface: SubscriptionCallbackMutationDirect %{#Interface:-SubscriptionCallbackMutationDirect}% +# Interface: SubscriptionCallbackMutationDirect [pinia](../modules/pinia.md).SubscriptionCallbackMutationDirect @@ -14,15 +14,15 @@ Context passed to a subscription callback when directly mutating the state of a store with `store.someState = newValue` or `store.$state.someState = newValue`. -## Hierarchy %{#Interface:-SubscriptionCallbackMutationDirect-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationDirect`** -## Properties %{#Interface:-SubscriptionCallbackMutationDirect-Properties}% +## Properties %{#Properties}% -### events %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events}% +### events %{#Properties-events}% • **events**: `DebuggerEvent` @@ -30,30 +30,30 @@ newValue`. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-events-Overrides}% +#### Overrides %{#Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### storeId %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId}% +### storeId %{#Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from %{#Interface:-SubscriptionCallbackMutationDirect-Properties-storeId-Inherited-from}% +#### Inherited from %{#Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type}% +### type %{#Properties-type}% • **type**: [`direct`](../enums/pinia.MutationType.md#direct) Type of the mutation. -#### Overrides %{#Interface:-SubscriptionCallbackMutationDirect-Properties-type-Overrides}% +#### Overrides %{#Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md index 833e34f1..ddbcc3f6 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md @@ -1,27 +1,27 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchFunction -# Interface: SubscriptionCallbackMutationPatchFunction %{#Interface:-SubscriptionCallbackMutationPatchFunction}% +# Interface: SubscriptionCallbackMutationPatchFunction [pinia](../modules/pinia.md).SubscriptionCallbackMutationPatchFunction Context passed to a subscription callback when `store.$patch()` is called with a function. -## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchFunction-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationPatchFunction`** -## Properties %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties}% +## Properties %{#Properties}% -### events %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events}% +### events %{#Properties-events}% • **events**: `DebuggerEvent`[] @@ -29,30 +29,30 @@ with a function. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-events-Overrides}% +#### Overrides %{#Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### storeId %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId}% +### storeId %{#Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-storeId-Inherited-from}% +#### Inherited from %{#Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type}% +### type %{#Properties-type}% • **type**: [`patchFunction`](../enums/pinia.MutationType.md#patchfunction) Type of the mutation. -#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchFunction-Properties-type-Overrides}% +#### Overrides %{#Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md index 37324bac..f171c7c8 100644 --- a/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md +++ b/packages/docs-new/api/interfaces/pinia.SubscriptionCallbackMutationPatchObject.md @@ -1,33 +1,33 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / SubscriptionCallbackMutationPatchObject -# Interface: SubscriptionCallbackMutationPatchObject %{#Interface:-SubscriptionCallbackMutationPatchObject}% +# Interface: SubscriptionCallbackMutationPatchObject [pinia](../modules/pinia.md).SubscriptionCallbackMutationPatchObject Context passed to a subscription callback when `store.$patch()` is called with an object. -## Type parameters %{#Interface:-SubscriptionCallbackMutationPatchObject-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | | :------ | | `S` | -## Hierarchy %{#Interface:-SubscriptionCallbackMutationPatchObject-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`_SubscriptionCallbackMutationBase`](pinia._SubscriptionCallbackMutationBase.md) ↳ **`SubscriptionCallbackMutationPatchObject`** -## Properties %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties}% +## Properties %{#Properties}% -### events %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-events}% +### events %{#Properties-events}% • **events**: `DebuggerEvent`[] @@ -35,13 +35,13 @@ with an object. https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in devtools and plugins **during development only**. -#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-events-Overrides}% +#### Overrides %{#Properties-events-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[events](pinia._SubscriptionCallbackMutationBase.md#events) ___ -### payload %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-payload}% +### payload %{#Properties-payload}% • **payload**: [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`S`\> @@ -49,24 +49,24 @@ Object passed to `store.$patch()`. ___ -### storeId %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-storeId}% +### storeId %{#Properties-storeId}% • **storeId**: `string` `id` of the store doing the mutation. -#### Inherited from %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-storeId-Inherited-from}% +#### Inherited from %{#Properties-storeId-Inherited-from}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[storeId](pinia._SubscriptionCallbackMutationBase.md#storeid) ___ -### type %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-type}% +### type %{#Properties-type}% • **type**: [`patchObject`](../enums/pinia.MutationType.md#patchobject) Type of the mutation. -#### Overrides %{#Interface:-SubscriptionCallbackMutationPatchObject-Properties-type-Overrides}% +#### Overrides %{#Properties-type-Overrides}% [_SubscriptionCallbackMutationBase](pinia._SubscriptionCallbackMutationBase.md).[type](pinia._SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md b/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md index 41abc59a..6be817a1 100644 --- a/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md +++ b/packages/docs-new/api/interfaces/pinia._StoreOnActionListenerContext.md @@ -1,12 +1,12 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreOnActionListenerContext -# Interface: \_StoreOnActionListenerContext %{#Interface:-\_StoreOnActionListenerContext}% +# Interface: \_StoreOnActionListenerContext [pinia](../modules/pinia.md)._StoreOnActionListenerContext @@ -14,7 +14,7 @@ Actual type for [StoreOnActionListenerContext](../modules/pinia.md#storeonaction purposes. For internal use only. For internal use **only** -## Type parameters %{#Interface:-\_StoreOnActionListenerContext-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -22,32 +22,32 @@ For internal use **only** | `ActionName` | extends `string` | | `A` | `A` | -## Properties %{#Interface:-\_StoreOnActionListenerContext-Properties}% +## Properties %{#Properties}% -### after %{#Interface:-\_StoreOnActionListenerContext-Properties-after}% +### after %{#Properties-after}% • **after**: (`callback`: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` : () => `void`) => `void` -#### Type declaration %{#Interface:-\_StoreOnActionListenerContext-Properties-after-Type-declaration}% +#### Type declaration %{#Properties-after-Type-declaration}% ▸ (`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. -##### Parameters %{#Interface:-\_StoreOnActionListenerContext-Properties-after-Type-declaration-Parameters}% +##### Parameters %{#Properties-after-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `callback` | `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? (`resolvedReturn`: [`_Awaited`](../modules/pinia.md#_awaited)<`ReturnType`<`A`[`ActionName`]\>\>) => `void` : () => `void` | -##### Returns %{#Interface:-\_StoreOnActionListenerContext-Properties-after-Type-declaration-Returns}% +##### Returns %{#Properties-after-Type-declaration-Returns}% `void` ___ -### args %{#Interface:-\_StoreOnActionListenerContext-Properties-args}% +### args %{#Properties-args}% • **args**: `A` extends `Record`<`ActionName`, [`_Method`](../modules/pinia.md#_method)\> ? `Parameters`<`A`[`ActionName`]\> : `unknown`[] @@ -55,7 +55,7 @@ Parameters passed to the action ___ -### name %{#Interface:-\_StoreOnActionListenerContext-Properties-name}% +### name %{#Properties-name}% • **name**: `ActionName` @@ -63,30 +63,30 @@ Name of the action ___ -### onError %{#Interface:-\_StoreOnActionListenerContext-Properties-onError}% +### onError %{#Properties-onError}% • **onError**: (`callback`: (`error`: `unknown`) => `void`) => `void` -#### Type declaration %{#Interface:-\_StoreOnActionListenerContext-Properties-onError-Type-declaration}% +#### Type declaration %{#Properties-onError-Type-declaration}% ▸ (`callback`): `void` Sets up a hook if the action fails. Return `false` to catch the error and stop it from propagating. -##### Parameters %{#Interface:-\_StoreOnActionListenerContext-Properties-onError-Type-declaration-Parameters}% +##### Parameters %{#Properties-onError-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `callback` | (`error`: `unknown`) => `void` | -##### Returns %{#Interface:-\_StoreOnActionListenerContext-Properties-onError-Type-declaration-Returns}% +##### Returns %{#Properties-onError-Type-declaration-Returns}% `void` ___ -### store %{#Interface:-\_StoreOnActionListenerContext-Properties-store}% +### store %{#Properties-store}% • **store**: `Store` diff --git a/packages/docs-new/api/interfaces/pinia._StoreWithState.md b/packages/docs-new/api/interfaces/pinia._StoreWithState.md index e320bb43..d3b4994b 100644 --- a/packages/docs-new/api/interfaces/pinia._StoreWithState.md +++ b/packages/docs-new/api/interfaces/pinia._StoreWithState.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_StoreWithState -# Interface: \_StoreWithState %{#Interface:-\_StoreWithState}% +# Interface: \_StoreWithState [pinia](../modules/pinia.md)._StoreWithState Base store with state and functions. Should not be used directly. -## Type parameters %{#Interface:-\_StoreWithState-Type-parameters}% +## Type parameters %{#Type-parameters}% | Name | Type | | :------ | :------ | @@ -21,27 +21,27 @@ Base store with state and functions. Should not be used directly. | `G` | `G` | | `A` | `A` | -## Hierarchy %{#Interface:-\_StoreWithState-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`StoreProperties`](pinia.StoreProperties.md)<`Id`\> ↳ **`_StoreWithState`** -## Properties %{#Interface:-\_StoreWithState-Properties}% +## Properties %{#Properties}% -### $id %{#Interface:-\_StoreWithState-Properties-$id}% +### $id %{#Properties-$id}% • **$id**: `Id` Unique identifier of the store -#### Inherited from %{#Interface:-\_StoreWithState-Properties-$id-Inherited-from}% +#### Inherited from %{#Properties-$id-Inherited-from}% [StoreProperties](pinia.StoreProperties.md).[$id](pinia.StoreProperties.md#$id) ___ -### $state %{#Interface:-\_StoreWithState-Properties-$state}% +### $state %{#Properties-$state}% • **$state**: `UnwrapRef`<`S`\> & [`PiniaCustomStateProperties`](pinia.PiniaCustomStateProperties.md)<`S`\> @@ -49,7 +49,7 @@ State of the Store. Setting it will replace the whole state. ___ -### \_customProperties %{#Interface:-\_StoreWithState-Properties-\_customProperties}% +### \_customProperties %{#Properties-\_customProperties}% • **\_customProperties**: `Set`<`string`\> @@ -57,13 +57,13 @@ 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 %{#Interface:-\_StoreWithState-Properties-\_customProperties-Inherited-from}% +#### Inherited from %{#Properties-\_customProperties-Inherited-from}% [StoreProperties](pinia.StoreProperties.md).[_customProperties](pinia.StoreProperties.md#_customproperties) -## Methods %{#Interface:-\_StoreWithState-Methods}% +## Methods %{#Methods}% -### $dispose %{#Interface:-\_StoreWithState-Methods-$dispose}% +### $dispose %{#Methods-$dispose}% ▸ **$dispose**(): `void` @@ -74,13 +74,13 @@ Note this doesn't delete the state of the store, you have to do it manually with `delete pinia.state.value[store.$id]` if you want to. If you don't and the store is used again, it will reuse the previous state. -#### Returns %{#Interface:-\_StoreWithState-Methods-$dispose-Returns}% +#### Returns %{#Methods-$dispose-Returns}% `void` ___ -### $onAction %{#Interface:-\_StoreWithState-Methods-$onAction}% +### $onAction %{#Methods-$onAction}% ▸ **$onAction**(`callback`, `detached?`): () => `void` @@ -115,14 +115,14 @@ store.$onAction(({ after, onError }) => { }) ``` -#### Parameters %{#Interface:-\_StoreWithState-Methods-$onAction-Parameters}% +#### Parameters %{#Methods-$onAction-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `callback` | [`StoreOnActionListener`](../modules/pinia.md#storeonactionlistener)<`Id`, `S`, `G`, `A`\> | callback called before every action | | `detached?` | `boolean` | detach the subscription from the context this is called from | -#### Returns %{#Interface:-\_StoreWithState-Methods-$onAction-Returns}% +#### Returns %{#Methods-$onAction-Returns}% `fn` @@ -161,7 +161,7 @@ store.$onAction(({ after, onError }) => { }) ``` -##### Returns %{#Interface:-\_StoreWithState-Methods-$onAction-Returns-Returns}% +##### Returns %{#Methods-$onAction-Returns-Returns}% `void` @@ -169,19 +169,19 @@ function that removes the watcher ___ -### $patch %{#Interface:-\_StoreWithState-Methods-$patch}% +### $patch %{#Methods-$patch}% ▸ **$patch**(`partialState`): `void` Applies a state patch to current state. Allows passing nested values -#### Parameters %{#Interface:-\_StoreWithState-Methods-$patch-Parameters}% +#### Parameters %{#Methods-$patch-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `partialState` | [`_DeepPartial`](../modules/pinia.md#_deeppartial)<`UnwrapRef`<`S`\>\> | patch to apply to the state | -#### Returns %{#Interface:-\_StoreWithState-Methods-$patch-Returns}% +#### Returns %{#Methods-$patch-Returns}% `void` @@ -191,38 +191,38 @@ Group multiple changes into one function. Useful when mutating objects like Sets or arrays and applying an object patch isn't practical, e.g. appending to an array. The function passed to `$patch()` **must be synchronous**. -#### Type parameters %{#Interface:-\_StoreWithState-Methods-$patch-Type-parameters}% +#### Type parameters %{#Methods-$patch-Type-parameters}% | Name | Type | | :------ | :------ | | `F` | extends (`state`: `UnwrapRef`<`S`\>) => `any` | -#### Parameters %{#Interface:-\_StoreWithState-Methods-$patch-Parameters_1}% +#### Parameters %{#Methods-$patch-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `stateMutator` | `ReturnType`<`F`\> extends `Promise`<`any`\> ? `never` : `F` | function that mutates `state`, cannot be async | -#### Returns %{#Interface:-\_StoreWithState-Methods-$patch-Returns_1}% +#### Returns %{#Methods-$patch-Returns_1}% `void` ___ -### $reset %{#Interface:-\_StoreWithState-Methods-$reset}% +### $reset %{#Methods-$reset}% ▸ **$reset**(): `void` Resets the store to its initial state by building a new state object. TODO: make this options only -#### Returns %{#Interface:-\_StoreWithState-Methods-$reset-Returns}% +#### Returns %{#Methods-$reset-Returns}% `void` ___ -### $subscribe %{#Interface:-\_StoreWithState-Methods-$subscribe}% +### $subscribe %{#Methods-$subscribe}% ▸ **$subscribe**(`callback`, `options?`): () => `void` @@ -230,14 +230,14 @@ Setups a callback to be called whenever the state changes. It also returns a fun that when calling `store.$subscribe()` inside of a component, it will be automatically cleaned up when the component gets unmounted unless `detached` is set to true. -#### Parameters %{#Interface:-\_StoreWithState-Methods-$subscribe-Parameters}% +#### Parameters %{#Methods-$subscribe-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `callback` | [`SubscriptionCallback`](../modules/pinia.md#subscriptioncallback)<`S`\> | callback passed to the watcher | | `options?` | { `detached?`: `boolean` } & `WatchOptions`<`boolean`\> | `watch` options + `detached` to detach the subscription from the context (usually a component) this is called from. Note that the `flush` option does not affect calls to `store.$patch()`. | -#### Returns %{#Interface:-\_StoreWithState-Methods-$subscribe-Returns}% +#### Returns %{#Methods-$subscribe-Returns}% `fn` @@ -249,7 +249,7 @@ Setups a callback to be called whenever the state changes. It also returns a fun that when calling `store.$subscribe()` inside of a component, it will be automatically cleaned up when the component gets unmounted unless `detached` is set to true. -##### Returns %{#Interface:-\_StoreWithState-Methods-$subscribe-Returns-Returns}% +##### Returns %{#Methods-$subscribe-Returns-Returns}% `void` diff --git a/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md b/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md index 5f1db675..dd02d2fa 100644 --- a/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md +++ b/packages/docs-new/api/interfaces/pinia._SubscriptionCallbackMutationBase.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [pinia](../modules/pinia.md) / \_SubscriptionCallbackMutationBase -# Interface: \_SubscriptionCallbackMutationBase %{#Interface:-\_SubscriptionCallbackMutationBase}% +# Interface: \_SubscriptionCallbackMutationBase [pinia](../modules/pinia.md)._SubscriptionCallbackMutationBase Base type for the context passed to a subscription callback. Internal type. -## Hierarchy %{#Interface:-\_SubscriptionCallbackMutationBase-Hierarchy}% +## Hierarchy %{#Hierarchy}% - **`_SubscriptionCallbackMutationBase`** @@ -22,9 +22,9 @@ Base type for the context passed to a subscription callback. Internal type. ↳ [`SubscriptionCallbackMutationPatchObject`](pinia.SubscriptionCallbackMutationPatchObject.md) -## Properties %{#Interface:-\_SubscriptionCallbackMutationBase-Properties}% +## Properties %{#Properties}% -### events %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-events}% +### events %{#Properties-events}% • `Optional` **events**: `DebuggerEvent` \| `DebuggerEvent`[] @@ -34,7 +34,7 @@ devtools and plugins **during development only**. ___ -### storeId %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-storeId}% +### storeId %{#Properties-storeId}% • **storeId**: `string` @@ -42,7 +42,7 @@ ___ ___ -### type %{#Interface:-\_SubscriptionCallbackMutationBase-Properties-type}% +### type %{#Properties-type}% • **type**: [`MutationType`](../enums/pinia.MutationType.md) diff --git a/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md b/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md index c9c08503..b55cfd48 100644 --- a/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md +++ b/packages/docs-new/api/interfaces/pinia_nuxt.ModuleOptions.md @@ -1,18 +1,18 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [@pinia/nuxt](../modules/pinia_nuxt.md) / ModuleOptions -# Interface: ModuleOptions %{#Interface:-ModuleOptions}% +# Interface: ModuleOptions [@pinia/nuxt](../modules/pinia_nuxt.md).ModuleOptions -## Properties %{#Interface:-ModuleOptions-Properties}% +## Properties %{#Properties}% -### autoImports %{#Interface:-ModuleOptions-Properties-autoImports}% +### autoImports %{#Properties-autoImports}% • `Optional` **autoImports**: (`string` \| [`string`, `string`])[] @@ -31,7 +31,7 @@ autoImports: [ ___ -### disableVuex %{#Interface:-ModuleOptions-Properties-disableVuex}% +### disableVuex %{#Properties-disableVuex}% • `Optional` **disableVuex**: `boolean` diff --git a/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md index 801b875b..4c24d0de 100644 --- a/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs-new/api/interfaces/pinia_testing.TestingOptions.md @@ -1,53 +1,53 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingOptions -# Interface: TestingOptions %{#Interface:-TestingOptions}% +# Interface: TestingOptions [@pinia/testing](../modules/pinia_testing.md).TestingOptions -## Properties %{#Interface:-TestingOptions-Properties}% +## Properties %{#Properties}% -### createSpy %{#Interface:-TestingOptions-Properties-createSpy}% +### createSpy %{#Properties-createSpy}% • `Optional` **createSpy**: (`fn?`: (...`args`: `any`[]) => `any`) => (...`args`: `any`[]) => `any` -#### Type declaration %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration}% +#### Type declaration %{#Properties-createSpy-Type-declaration}% ▸ (`fn?`): (...`args`: `any`[]) => `any` Function used to create a spy for actions and `$patch()`. Pre-configured with `jest.fn()` in jest projects or `vi.fn()` in vitest projects. -##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters}% +##### Parameters %{#Properties-createSpy-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `fn?` | (...`args`: `any`[]) => `any` | -##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns}% +##### Returns %{#Properties-createSpy-Type-declaration-Returns}% `fn` ▸ (...`args`): `any` -##### Parameters %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Parameters_1}% +##### Parameters %{#Properties-createSpy-Type-declaration-Parameters_1}% | Name | Type | | :------ | :------ | | `...args` | `any`[] | -##### Returns %{#Interface:-TestingOptions-Properties-createSpy-Type-declaration-Returns_1}% +##### Returns %{#Properties-createSpy-Type-declaration-Returns_1}% `any` ___ -### fakeApp %{#Interface:-TestingOptions-Properties-fakeApp}% +### fakeApp %{#Properties-fakeApp}% • `Optional` **fakeApp**: `boolean` @@ -58,7 +58,7 @@ Defaults to false. ___ -### initialState %{#Interface:-TestingOptions-Properties-initialState}% +### initialState %{#Properties-initialState}% • `Optional` **initialState**: [`StateTree`](../modules/pinia.md#statetree) @@ -67,7 +67,7 @@ allowing you to only set a few properties that are required in your test. ___ -### plugins %{#Interface:-TestingOptions-Properties-plugins}% +### plugins %{#Properties-plugins}% • `Optional` **plugins**: [`PiniaPlugin`](pinia.PiniaPlugin.md)[] @@ -76,7 +76,7 @@ your application that will be used while testing. ___ -### stubActions %{#Interface:-TestingOptions-Properties-stubActions}% +### stubActions %{#Properties-stubActions}% • `Optional` **stubActions**: `boolean` @@ -88,7 +88,7 @@ handle this in `createSpy()`. ___ -### stubPatch %{#Interface:-TestingOptions-Properties-stubPatch}% +### stubPatch %{#Properties-stubPatch}% • `Optional` **stubPatch**: `boolean` diff --git a/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md b/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md index ac833ab0..09b4f619 100644 --- a/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md +++ b/packages/docs-new/api/interfaces/pinia_testing.TestingPinia.md @@ -1,27 +1,27 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / [@pinia/testing](../modules/pinia_testing.md) / TestingPinia -# Interface: TestingPinia %{#Interface:-TestingPinia}% +# Interface: TestingPinia [@pinia/testing](../modules/pinia_testing.md).TestingPinia Pinia instance specifically designed for testing. Extends a regular `Pinia` instance with test specific properties. -## Hierarchy %{#Interface:-TestingPinia-Hierarchy}% +## Hierarchy %{#Hierarchy}% - [`Pinia`](pinia.Pinia.md) ↳ **`TestingPinia`** -## Properties %{#Interface:-TestingPinia-Properties}% +## Properties %{#Properties}% -### app %{#Interface:-TestingPinia-Properties-app}% +### app %{#Properties-app}% • **app**: `App`<`any`\> @@ -29,58 +29,58 @@ App used by Pinia ___ -### install %{#Interface:-TestingPinia-Properties-install}% +### install %{#Properties-install}% • **install**: (`app`: `App`<`any`\>) => `void` -#### Type declaration %{#Interface:-TestingPinia-Properties-install-Type-declaration}% +#### Type declaration %{#Properties-install-Type-declaration}% ▸ (`app`): `void` -##### Parameters %{#Interface:-TestingPinia-Properties-install-Type-declaration-Parameters}% +##### Parameters %{#Properties-install-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `app` | `App`<`any`\> | -##### Returns %{#Interface:-TestingPinia-Properties-install-Type-declaration-Returns}% +##### Returns %{#Properties-install-Type-declaration-Returns}% `void` -#### Inherited from %{#Interface:-TestingPinia-Properties-install-Inherited-from}% +#### Inherited from %{#Properties-install-Inherited-from}% [Pinia](pinia.Pinia.md).[install](pinia.Pinia.md#install) ___ -### state %{#Interface:-TestingPinia-Properties-state}% +### state %{#Properties-state}% • **state**: `Ref`<`Record`<`string`, [`StateTree`](../modules/pinia.md#statetree)\>\> root state -#### Inherited from %{#Interface:-TestingPinia-Properties-state-Inherited-from}% +#### Inherited from %{#Properties-state-Inherited-from}% [Pinia](pinia.Pinia.md).[state](pinia.Pinia.md#state) -## Methods %{#Interface:-TestingPinia-Methods}% +## Methods %{#Methods}% -### use %{#Interface:-TestingPinia-Methods-use}% +### use %{#Methods-use}% ▸ **use**(`plugin`): [`Pinia`](pinia.Pinia.md) Adds a store plugin to extend every store -#### Parameters %{#Interface:-TestingPinia-Methods-use-Parameters}% +#### Parameters %{#Methods-use-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `plugin` | [`PiniaPlugin`](pinia.PiniaPlugin.md) | store plugin to add | -#### Returns %{#Interface:-TestingPinia-Methods-use-Returns}% +#### Returns %{#Methods-use-Returns}% [`Pinia`](pinia.Pinia.md) -#### Inherited from %{#Interface:-TestingPinia-Methods-use-Inherited-from}% +#### Inherited from %{#Methods-use-Inherited-from}% [Pinia](pinia.Pinia.md).[use](pinia.Pinia.md#use) diff --git a/packages/docs-new/api/modules/pinia.md b/packages/docs-new/api/modules/pinia.md index d351fd15..40b3aca9 100644 --- a/packages/docs-new/api/modules/pinia.md +++ b/packages/docs-new/api/modules/pinia.md @@ -1,18 +1,17 @@ --- -sidebar: "auto" -editLinks: false -sidebarDepth: 3 +editLink: false +outline: [2, 3] --- [API Documentation](../index.md) / pinia -# Module: pinia %{#Module:-pinia}% +# Module: pinia -## Enumerations %{#Module:-pinia-Enumerations}% +## Enumerations %{#Enumerations}% - [MutationType](../enums/pinia.MutationType.md) -## Interfaces %{#Module:-pinia-Interfaces}% +## Interfaces %{#Interfaces}% - [DefineSetupStoreOptions](../interfaces/pinia.DefineSetupStoreOptions.md) - [DefineStoreOptions](../interfaces/pinia.DefineStoreOptions.md) @@ -33,9 +32,9 @@ sidebarDepth: 3 - [\_StoreWithState](../interfaces/pinia._StoreWithState.md) - [\_SubscriptionCallbackMutationBase](../interfaces/pinia._SubscriptionCallbackMutationBase.md) -## Type Aliases %{#Module:-pinia-Type-Aliases}% +## Type Aliases %{#Type-Aliases}% -### PiniaStorePlugin %{#Module:-pinia-Type-Aliases-PiniaStorePlugin}% +### PiniaStorePlugin %{#Type-Aliases-PiniaStorePlugin}% Ƭ **PiniaStorePlugin**: [`PiniaPlugin`](../interfaces/pinia.PiniaPlugin.md) @@ -47,7 +46,7 @@ use PiniaPlugin instead ___ -### StateTree %{#Module:-pinia-Type-Aliases-StateTree}% +### StateTree %{#Type-Aliases-StateTree}% Ƭ **StateTree**: `Record`<`string` \| `number` \| `symbol`, `any`\> @@ -55,13 +54,13 @@ Generic state of a Store ___ -### Store %{#Module:-pinia-Type-Aliases-Store}% +### Store %{#Type-Aliases-Store}% Ƭ **Store**<`Id`, `S`, `G`, `A`\>: [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`Id`, `S`, `G`, `A`\> & `UnwrapRef`<`S`\> & [`_StoreWithGetters`](pinia.md#_storewithgetters)<`G`\> & [`_ActionsTree`](pinia.md#_actionstree) extends `A` ? {} : `A` & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`Id`, `S`, `G`, `A`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<`S`\> Store type to build a store. -#### Type parameters %{#Module:-pinia-Type-Aliases-Store-Type-parameters}% +#### Type parameters %{#Type-Aliases-Store-Type-parameters}% | Name | Type | | :------ | :------ | @@ -72,14 +71,14 @@ Store type to build a store. ___ -### StoreActions %{#Module:-pinia-Type-Aliases-StoreActions}% +### StoreActions %{#Type-Aliases-StoreActions}% Ƭ **StoreActions**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, infer A\> ? `A` : [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\> Extract the actions of a store type. Works with both a Setup Store or an Options Store. -#### Type parameters %{#Module:-pinia-Type-Aliases-StoreActions-Type-parameters}% +#### Type parameters %{#Type-Aliases-StoreActions-Type-parameters}% | Name | | :------ | @@ -87,7 +86,7 @@ Options Store. ___ -### StoreGeneric %{#Module:-pinia-Type-Aliases-StoreGeneric}% +### StoreGeneric %{#Type-Aliases-StoreGeneric}% Ƭ **StoreGeneric**: [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> @@ -97,14 +96,14 @@ about the kind of store that is passed. ___ -### StoreGetters %{#Module:-pinia-Type-Aliases-StoreGetters}% +### StoreGetters %{#Type-Aliases-StoreGetters}% Ƭ **StoreGetters**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, [`StateTree`](pinia.md#statetree), infer G, [`_ActionsTree`](pinia.md#_actionstree)\> ? [`_StoreWithGetters`](pinia.md#_storewithgetters)<`G`\> : [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\> Extract the getters of a store type. Works with both a Setup Store or an Options Store. -#### Type parameters %{#Module:-pinia-Type-Aliases-StoreGetters-Type-parameters}% +#### Type parameters %{#Type-Aliases-StoreGetters-Type-parameters}% | Name | | :------ | @@ -112,11 +111,11 @@ Options Store. ___ -### StoreOnActionListener %{#Module:-pinia-Type-Aliases-StoreOnActionListener}% +### StoreOnActionListener %{#Type-Aliases-StoreOnActionListener}% Ƭ **StoreOnActionListener**<`Id`, `S`, `G`, `A`\>: (`context`: [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\>) => `void` -#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-parameters}% +#### Type parameters %{#Type-Aliases-StoreOnActionListener-Type-parameters}% | Name | Type | | :------ | :------ | @@ -125,32 +124,32 @@ ___ | `G` | `G` | | `A` | `A` | -#### Type declaration %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration}% +#### Type declaration %{#Type-Aliases-StoreOnActionListener-Type-declaration}% ▸ (`context`): `void` Argument of `store.$onAction()` -##### Parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Parameters}% +##### Parameters %{#Type-Aliases-StoreOnActionListener-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `context` | [`StoreOnActionListenerContext`](pinia.md#storeonactionlistenercontext)<`Id`, `S`, `G`, {} extends `A` ? [`_ActionsTree`](pinia.md#_actionstree) : `A`\> | -##### Returns %{#Module:-pinia-Type-Aliases-StoreOnActionListener-Type-declaration-Returns}% +##### Returns %{#Type-Aliases-StoreOnActionListener-Type-declaration-Returns}% `void` ___ -### StoreOnActionListenerContext %{#Module:-pinia-Type-Aliases-StoreOnActionListenerContext}% +### StoreOnActionListenerContext %{#Type-Aliases-StoreOnActionListenerContext}% Ƭ **StoreOnActionListenerContext**<`Id`, `S`, `G`, `A`\>: [`_ActionsTree`](pinia.md#_actionstree) extends `A` ? [`_StoreOnActionListenerContext`](../interfaces/pinia._StoreOnActionListenerContext.md)<[`StoreGeneric`](pinia.md#storegeneric), `string`, [`_ActionsTree`](pinia.md#_actionstree)\> : { [Name in keyof A]: Name extends string ? \_StoreOnActionListenerContext, Name, A\> : never }[keyof `A`] Context object passed to callbacks of `store.$onAction(context => {})` TODO: should have only the Id, the Store and Actions to generate the proper object -#### Type parameters %{#Module:-pinia-Type-Aliases-StoreOnActionListenerContext-Type-parameters}% +#### Type parameters %{#Type-Aliases-StoreOnActionListenerContext-Type-parameters}% | Name | Type | | :------ | :------ | @@ -161,14 +160,14 @@ TODO: should have only the Id, the Store and Actions to generate the proper obje ___ -### StoreState %{#Module:-pinia-Type-Aliases-StoreState}% +### StoreState %{#Type-Aliases-StoreState}% Ƭ **StoreState**<`SS`\>: `SS` extends [`Store`](pinia.md#store)<`string`, infer S, [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> ? `UnwrapRef`<`S`\> : [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\> Extract the state of a store type. Works with both a Setup Store or an Options Store. Note this unwraps refs. -#### Type parameters %{#Module:-pinia-Type-Aliases-StoreState-Type-parameters}% +#### Type parameters %{#Type-Aliases-StoreState-Type-parameters}% | Name | | :------ | @@ -176,42 +175,42 @@ Options Store. Note this unwraps refs. ___ -### SubscriptionCallback %{#Module:-pinia-Type-Aliases-SubscriptionCallback}% +### SubscriptionCallback %{#Type-Aliases-SubscriptionCallback}% Ƭ **SubscriptionCallback**<`S`\>: (`mutation`: [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\>, `state`: `UnwrapRef`<`S`\>) => `void` -#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-parameters}% +#### Type parameters %{#Type-Aliases-SubscriptionCallback-Type-parameters}% | Name | | :------ | | `S` | -#### Type declaration %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration}% +#### Type declaration %{#Type-Aliases-SubscriptionCallback-Type-declaration}% ▸ (`mutation`, `state`): `void` Callback of a subscription -##### Parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Parameters}% +##### Parameters %{#Type-Aliases-SubscriptionCallback-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `mutation` | [`SubscriptionCallbackMutation`](pinia.md#subscriptioncallbackmutation)<`S`\> | | `state` | `UnwrapRef`<`S`\> | -##### Returns %{#Module:-pinia-Type-Aliases-SubscriptionCallback-Type-declaration-Returns}% +##### Returns %{#Type-Aliases-SubscriptionCallback-Type-declaration-Returns}% `void` ___ -### SubscriptionCallbackMutation %{#Module:-pinia-Type-Aliases-SubscriptionCallbackMutation}% +### SubscriptionCallbackMutation %{#Type-Aliases-SubscriptionCallbackMutation}% Ƭ **SubscriptionCallbackMutation**<`S`\>: [`SubscriptionCallbackMutationDirect`](../interfaces/pinia.SubscriptionCallbackMutationDirect.md) \| [`SubscriptionCallbackMutationPatchObject`](../interfaces/pinia.SubscriptionCallbackMutationPatchObject.md)<`S`\> \| [`SubscriptionCallbackMutationPatchFunction`](../interfaces/pinia.SubscriptionCallbackMutationPatchFunction.md) Context object passed to a subscription callback. -#### Type parameters %{#Module:-pinia-Type-Aliases-SubscriptionCallbackMutation-Type-parameters}% +#### Type parameters %{#Type-Aliases-SubscriptionCallbackMutation-Type-parameters}% | Name | | :------ | @@ -219,7 +218,7 @@ Context object passed to a subscription callback. ___ -### \_ActionsTree %{#Module:-pinia-Type-Aliases-\_ActionsTree}% +### \_ActionsTree %{#Type-Aliases-\_ActionsTree}% Ƭ **\_ActionsTree**: `Record`<`string`, [`_Method`](pinia.md#_method)\> @@ -228,11 +227,11 @@ For internal use **only** ___ -### \_Awaited %{#Module:-pinia-Type-Aliases-\_Awaited}% +### \_Awaited %{#Type-Aliases-\_Awaited}% Ƭ **\_Awaited**<`T`\>: `T` extends ``null`` \| `undefined` ? `T` : `T` extends `object` & { `then`: (`onfulfilled`: `F`) => `any` } ? `F` extends (`value`: infer V, ...`args`: `any`) => `any` ? [`_Awaited`](pinia.md#_awaited)<`V`\> : `never` : `T` -#### Type parameters %{#Module:-pinia-Type-Aliases-\_Awaited-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_Awaited-Type-parameters}% | Name | | :------ | @@ -240,7 +239,7 @@ ___ ___ -### \_DeepPartial %{#Module:-pinia-Type-Aliases-\_DeepPartial}% +### \_DeepPartial %{#Type-Aliases-\_DeepPartial}% Ƭ **\_DeepPartial**<`T`\>: { [K in keyof T]?: \_DeepPartial } @@ -248,7 +247,7 @@ Recursive `Partial`. Used by [['$patch']](pinia.md#store). For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_DeepPartial-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_DeepPartial-Type-parameters}% | Name | | :------ | @@ -256,13 +255,13 @@ For internal use **only** ___ -### \_ExtractActionsFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore}% +### \_ExtractActionsFromSetupStore %{#Type-Aliases-\_ExtractActionsFromSetupStore}% Ƭ **\_ExtractActionsFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractActionsFromSetupStore_Keys`](pinia.md#_extractactionsfromsetupstore_keys)<`SS`\> extends keyof `SS` ? `Pick`<`SS`, [`_ExtractActionsFromSetupStore_Keys`](pinia.md#_extractactionsfromsetupstore_keys)<`SS`\>\> : `never` For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractActionsFromSetupStore-Type-parameters}% | Name | | :------ | @@ -270,14 +269,14 @@ For internal use **only** ___ -### \_ExtractActionsFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore\_Keys}% +### \_ExtractActionsFromSetupStore\_Keys %{#Type-Aliases-\_ExtractActionsFromSetupStore\_Keys}% Ƭ **\_ExtractActionsFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends \_Method ? K : never]: any } Type that enables refactoring through IDE. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractActionsFromSetupStore\_Keys-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractActionsFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -285,13 +284,13 @@ For internal use **only** ___ -### \_ExtractGettersFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore}% +### \_ExtractGettersFromSetupStore %{#Type-Aliases-\_ExtractGettersFromSetupStore}% Ƭ **\_ExtractGettersFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\> extends keyof `SS` ? `Pick`<`SS`, [`_ExtractGettersFromSetupStore_Keys`](pinia.md#_extractgettersfromsetupstore_keys)<`SS`\>\> : `never` For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractGettersFromSetupStore-Type-parameters}% | Name | | :------ | @@ -299,14 +298,14 @@ For internal use **only** ___ -### \_ExtractGettersFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore\_Keys}% +### \_ExtractGettersFromSetupStore\_Keys %{#Type-Aliases-\_ExtractGettersFromSetupStore\_Keys}% Ƭ **\_ExtractGettersFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends ComputedRef ? K : never]: any } Type that enables refactoring through IDE. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractGettersFromSetupStore\_Keys-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractGettersFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -314,13 +313,13 @@ For internal use **only** ___ -### \_ExtractStateFromSetupStore %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore}% +### \_ExtractStateFromSetupStore %{#Type-Aliases-\_ExtractStateFromSetupStore}% Ƭ **\_ExtractStateFromSetupStore**<`SS`\>: `SS` extends `undefined` \| `void` ? {} : [`_ExtractStateFromSetupStore_Keys`](pinia.md#_extractstatefromsetupstore_keys)<`SS`\> extends keyof `SS` ? [`_UnwrapAll`](pinia.md#_unwrapall)<`Pick`<`SS`, [`_ExtractStateFromSetupStore_Keys`](pinia.md#_extractstatefromsetupstore_keys)<`SS`\>\>\> : `never` For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractStateFromSetupStore-Type-parameters}% | Name | | :------ | @@ -328,14 +327,14 @@ For internal use **only** ___ -### \_ExtractStateFromSetupStore\_Keys %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore\_Keys}% +### \_ExtractStateFromSetupStore\_Keys %{#Type-Aliases-\_ExtractStateFromSetupStore\_Keys}% Ƭ **\_ExtractStateFromSetupStore\_Keys**<`SS`\>: keyof { [K in keyof SS as SS[K] extends \_Method \| ComputedRef ? never : K]: any } Type that enables refactoring through IDE. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_ExtractStateFromSetupStore\_Keys-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_ExtractStateFromSetupStore\_Keys-Type-parameters}% | Name | | :------ | @@ -343,14 +342,14 @@ For internal use **only** ___ -### \_GettersTree %{#Module:-pinia-Type-Aliases-\_GettersTree}% +### \_GettersTree %{#Type-Aliases-\_GettersTree}% Ƭ **\_GettersTree**<`S`\>: `Record`<`string`, (`state`: `UnwrapRef`<`S`\> & `UnwrapRef`<[`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<`S`\>\>) => `any` \| () => `any`\> Type of an object of Getters that infers the argument. For internal usage only. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_GettersTree-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_GettersTree-Type-parameters}% | Name | Type | | :------ | :------ | @@ -358,13 +357,13 @@ For internal use **only** ___ -### \_MapActionsObjectReturn %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn}% +### \_MapActionsObjectReturn %{#Type-Aliases-\_MapActionsObjectReturn}% Ƭ **\_MapActionsObjectReturn**<`A`, `T`\>: { [key in keyof T]: A[T[key]] } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsObjectReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapActionsObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -373,13 +372,13 @@ For internal use **only** ___ -### \_MapActionsReturn %{#Module:-pinia-Type-Aliases-\_MapActionsReturn}% +### \_MapActionsReturn %{#Type-Aliases-\_MapActionsReturn}% Ƭ **\_MapActionsReturn**<`A`\>: { [key in keyof A]: A[key] } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapActionsReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapActionsReturn-Type-parameters}% | Name | | :------ | @@ -387,13 +386,13 @@ For internal use **only** ___ -### \_MapStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn}% +### \_MapStateObjectReturn %{#Type-Aliases-\_MapStateObjectReturn}% Ƭ **\_MapStateObjectReturn**<`Id`, `S`, `G`, `A`, `T`\>: { [key in keyof T]: Function } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateObjectReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapStateObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -405,13 +404,13 @@ For internal use **only** ___ -### \_MapStateReturn %{#Module:-pinia-Type-Aliases-\_MapStateReturn}% +### \_MapStateReturn %{#Type-Aliases-\_MapStateReturn}% Ƭ **\_MapStateReturn**<`S`, `G`, `Keys`\>: { [key in Keys]: Function } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapStateReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapStateReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -421,13 +420,13 @@ For internal use **only** ___ -### \_MapWritableStateObjectReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn}% +### \_MapWritableStateObjectReturn %{#Type-Aliases-\_MapWritableStateObjectReturn}% Ƭ **\_MapWritableStateObjectReturn**<`S`, `T`\>: { [key in keyof T]: Object } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateObjectReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapWritableStateObjectReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -436,13 +435,13 @@ For internal use **only** ___ -### \_MapWritableStateReturn %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn}% +### \_MapWritableStateReturn %{#Type-Aliases-\_MapWritableStateReturn}% Ƭ **\_MapWritableStateReturn**<`S`\>: { [key in keyof S]: Object } For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_MapWritableStateReturn-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_MapWritableStateReturn-Type-parameters}% | Name | Type | | :------ | :------ | @@ -450,11 +449,11 @@ For internal use **only** ___ -### \_Method %{#Module:-pinia-Type-Aliases-\_Method}% +### \_Method %{#Type-Aliases-\_Method}% Ƭ **\_Method**: (...`args`: `any`[]) => `any` -#### Type declaration %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration}% +#### Type declaration %{#Type-Aliases-\_Method-Type-declaration}% ▸ (...`args`): `any` @@ -462,25 +461,25 @@ Generic type for a function that can infer arguments and return type For internal use **only** -##### Parameters %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Parameters}% +##### Parameters %{#Type-Aliases-\_Method-Type-declaration-Parameters}% | Name | Type | | :------ | :------ | | `...args` | `any`[] | -##### Returns %{#Module:-pinia-Type-Aliases-\_Method-Type-declaration-Returns}% +##### Returns %{#Type-Aliases-\_Method-Type-declaration-Returns}% `any` ___ -### \_Spread %{#Module:-pinia-Type-Aliases-\_Spread}% +### \_Spread %{#Type-Aliases-\_Spread}% Ƭ **\_Spread**<`A`\>: `A` extends [infer L, ...(infer R)] ? [`_StoreObject`](pinia.md#_storeobject)<`L`\> & [`_Spread`](pinia.md#_spread)<`R`\> : `unknown` For internal use **only**. -#### Type parameters %{#Module:-pinia-Type-Aliases-\_Spread-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_Spread-Type-parameters}% | Name | Type | | :------ | :------ | @@ -488,13 +487,13 @@ For internal use **only**. ___ -### \_StoreObject %{#Module:-pinia-Type-Aliases-\_StoreObject}% +### \_StoreObject %{#Type-Aliases-\_StoreObject}% Ƭ **\_StoreObject**<`S`\>: `S` extends [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md) ? { [Id in \`${Ids}${MapStoresCustomization extends Record<"suffix", infer Suffix\> ? Suffix : "Store"}\`]: Function } : {} For internal use **only**. -#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreObject-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_StoreObject-Type-parameters}% | Name | | :------ | @@ -502,14 +501,14 @@ For internal use **only**. ___ -### \_StoreWithActions %{#Module:-pinia-Type-Aliases-\_StoreWithActions}% +### \_StoreWithActions %{#Type-Aliases-\_StoreWithActions}% Ƭ **\_StoreWithActions**<`A`\>: { [k in keyof A]: A[k] extends Function ? Function : never } Store augmented for actions. For internal usage only. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithActions-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_StoreWithActions-Type-parameters}% | Name | | :------ | @@ -517,14 +516,14 @@ For internal use **only** ___ -### \_StoreWithGetters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters}% +### \_StoreWithGetters %{#Type-Aliases-\_StoreWithGetters}% Ƭ **\_StoreWithGetters**<`G`\>: { readonly [k in keyof G]: G[k] extends Function ? R : UnwrapRef } Store augmented with getters. For internal usage only. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_StoreWithGetters-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_StoreWithGetters-Type-parameters}% | Name | | :------ | @@ -532,28 +531,28 @@ For internal use **only** ___ -### \_UnwrapAll %{#Module:-pinia-Type-Aliases-\_UnwrapAll}% +### \_UnwrapAll %{#Type-Aliases-\_UnwrapAll}% Ƭ **\_UnwrapAll**<`SS`\>: { [K in keyof SS]: UnwrapRef } Type that enables refactoring through IDE. For internal use **only** -#### Type parameters %{#Module:-pinia-Type-Aliases-\_UnwrapAll-Type-parameters}% +#### Type parameters %{#Type-Aliases-\_UnwrapAll-Type-parameters}% | Name | | :------ | | `SS` | -## Variables %{#Module:-pinia-Variables}% +## Variables %{#Variables}% -### PiniaVuePlugin %{#Module:-pinia-Variables-PiniaVuePlugin}% +### PiniaVuePlugin %{#Variables-PiniaVuePlugin}% • `Const` **PiniaVuePlugin**: `Plugin` 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`** @@ -575,9 +574,9 @@ new Vue({ `Vue` imported from 'vue'. -## Functions %{#Module:-pinia-Functions}% +## Functions %{#Functions}% -### acceptHMRUpdate %{#Module:-pinia-Functions-acceptHMRUpdate}% +### acceptHMRUpdate %{#Functions-acceptHMRUpdate}% ▸ **acceptHMRUpdate**(`initialUseStore`, `hot`): (`newModule`: `any`) => `any` @@ -592,50 +591,50 @@ if (import.meta.hot) { } ``` -#### Parameters %{#Module:-pinia-Functions-acceptHMRUpdate-Parameters}% +#### Parameters %{#Functions-acceptHMRUpdate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `initialUseStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree)\> | return of the defineStore to hot update | | `hot` | `any` | `import.meta.hot` | -#### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns}% +#### Returns %{#Functions-acceptHMRUpdate-Returns}% `fn` ▸ (`newModule`): `any` -##### Parameters %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Parameters}% +##### Parameters %{#Functions-acceptHMRUpdate-Returns-Parameters}% | Name | Type | | :------ | :------ | | `newModule` | `any` | -##### Returns %{#Module:-pinia-Functions-acceptHMRUpdate-Returns-Returns}% +##### Returns %{#Functions-acceptHMRUpdate-Returns-Returns}% `any` ___ -### createPinia %{#Module:-pinia-Functions-createPinia}% +### createPinia %{#Functions-createPinia}% ▸ **createPinia**(): [`Pinia`](../interfaces/pinia.Pinia.md) Creates a Pinia instance to be used by the application -#### Returns %{#Module:-pinia-Functions-createPinia-Returns}% +#### Returns %{#Functions-createPinia-Returns}% [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### defineStore %{#Module:-pinia-Functions-defineStore}% +### defineStore %{#Functions-defineStore}% ▸ **defineStore**<`Id`, `S`, `G`, `A`\>(`id`, `options`): [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> Creates a `useStore` function that retrieves the store instance -#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters}% +#### Type parameters %{#Functions-defineStore-Type-parameters}% | Name | Type | | :------ | :------ | @@ -644,14 +643,14 @@ Creates a `useStore` function that retrieves the store instance | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | | `A` | {} | -#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters}% +#### Parameters %{#Functions-defineStore-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `id` | `Id` | id of the store (must be unique) | | `options` | `Omit`<[`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\>, ``"id"``\> | options to define the store | -#### Returns %{#Module:-pinia-Functions-defineStore-Returns}% +#### Returns %{#Functions-defineStore-Returns}% [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -659,7 +658,7 @@ Creates a `useStore` function that retrieves the store instance Creates a `useStore` function that retrieves the store instance -#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_1}% +#### Type parameters %{#Functions-defineStore-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -668,13 +667,13 @@ Creates a `useStore` function that retrieves the store instance | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> = {} | | `A` | {} | -#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_1}% +#### Parameters %{#Functions-defineStore-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `options` | [`DefineStoreOptions`](../interfaces/pinia.DefineStoreOptions.md)<`Id`, `S`, `G`, `A`\> | options to define the store | -#### Returns %{#Module:-pinia-Functions-defineStore-Returns_1}% +#### Returns %{#Functions-defineStore-Returns_1}% [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> @@ -682,14 +681,14 @@ Creates a `useStore` function that retrieves the store instance Creates a `useStore` function that retrieves the store instance -#### Type parameters %{#Module:-pinia-Functions-defineStore-Type-parameters_2}% +#### Type parameters %{#Functions-defineStore-Type-parameters_2}% | Name | Type | | :------ | :------ | | `Id` | extends `string` | | `SS` | `SS` | -#### Parameters %{#Module:-pinia-Functions-defineStore-Parameters_2}% +#### Parameters %{#Functions-defineStore-Parameters_2}% | Name | Type | Description | | :------ | :------ | :------ | @@ -697,25 +696,25 @@ Creates a `useStore` function that retrieves the store instance | `storeSetup` | () => `SS` | function that defines the store | | `options?` | [`DefineSetupStoreOptions`](../interfaces/pinia.DefineSetupStoreOptions.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> | extra options | -#### Returns %{#Module:-pinia-Functions-defineStore-Returns_2}% +#### Returns %{#Functions-defineStore-Returns_2}% [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, [`_ExtractStateFromSetupStore`](pinia.md#_extractstatefromsetupstore)<`SS`\>, [`_ExtractGettersFromSetupStore`](pinia.md#_extractgettersfromsetupstore)<`SS`\>, [`_ExtractActionsFromSetupStore`](pinia.md#_extractactionsfromsetupstore)<`SS`\>\> ___ -### getActivePinia %{#Module:-pinia-Functions-getActivePinia}% +### getActivePinia %{#Functions-getActivePinia}% ▸ **getActivePinia**(): `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) Get the currently active pinia if there is any. -#### Returns %{#Module:-pinia-Functions-getActivePinia-Returns}% +#### Returns %{#Functions-getActivePinia-Returns}% `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### mapActions %{#Module:-pinia-Functions-mapActions}% +### mapActions %{#Functions-mapActions}% ▸ **mapActions**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> @@ -741,7 +740,7 @@ export default { } ``` -#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters}% +#### Type parameters %{#Functions-mapActions-Type-parameters}% | Name | Type | | :------ | :------ | @@ -751,14 +750,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `A`\> | -#### Parameters %{#Module:-pinia-Functions-mapActions-Parameters}% +#### Parameters %{#Functions-mapActions-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object to define new names for the actions | -#### Returns %{#Module:-pinia-Functions-mapActions-Returns}% +#### Returns %{#Functions-mapActions-Returns}% [`_MapActionsObjectReturn`](pinia.md#_mapactionsobjectreturn)<`A`, `KeyMapper`\> @@ -784,7 +783,7 @@ export default { } ``` -#### Type parameters %{#Module:-pinia-Functions-mapActions-Type-parameters_1}% +#### Type parameters %{#Functions-mapActions-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -793,20 +792,20 @@ export default { | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### Parameters %{#Module:-pinia-Functions-mapActions-Parameters_1}% +#### Parameters %{#Functions-mapActions-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | keyof `A`[] | array of action names to map | -#### Returns %{#Module:-pinia-Functions-mapActions-Returns_1}% +#### Returns %{#Functions-mapActions-Returns_1}% [`_MapActionsReturn`](pinia.md#_mapactionsreturn)<`A`\> ___ -### mapGetters %{#Module:-pinia-Functions-mapGetters}% +### mapGetters %{#Functions-mapGetters}% ▸ **mapGetters**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -816,7 +815,7 @@ Alias for `mapState()`. You should use `mapState()` instead. use `mapState()` instead. -#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters}% +#### Type parameters %{#Functions-mapGetters-Type-parameters}% | Name | Type | | :------ | :------ | @@ -826,14 +825,14 @@ use `mapState()` instead. | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters}% +#### Parameters %{#Functions-mapGetters-Parameters}% | Name | Type | | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | | `keyMapper` | `KeyMapper` | -#### Returns %{#Module:-pinia-Functions-mapGetters-Returns}% +#### Returns %{#Functions-mapGetters-Returns}% [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -845,7 +844,7 @@ Alias for `mapState()`. You should use `mapState()` instead. use `mapState()` instead. -#### Type parameters %{#Module:-pinia-Functions-mapGetters-Type-parameters_1}% +#### Type parameters %{#Functions-mapGetters-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -855,20 +854,20 @@ use `mapState()` instead. | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### Parameters %{#Module:-pinia-Functions-mapGetters-Parameters_1}% +#### Parameters %{#Functions-mapGetters-Parameters_1}% | Name | Type | | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | | `keys` | readonly `Keys`[] | -#### Returns %{#Module:-pinia-Functions-mapGetters-Returns_1}% +#### Returns %{#Functions-mapGetters-Returns_1}% [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> ___ -### mapState %{#Module:-pinia-Functions-mapState}% +### mapState %{#Functions-mapState}% ▸ **mapState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -905,7 +904,7 @@ export default { } ``` -#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters}% +#### Type parameters %{#Functions-mapState-Type-parameters}% | Name | Type | | :------ | :------ | @@ -915,14 +914,14 @@ export default { | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S` \| keyof `G` \| (`store`: [`Store`](pinia.md#store)<`Id`, `S`, `G`, `A`\>) => `any`\> | -#### Parameters %{#Module:-pinia-Functions-mapState-Parameters}% +#### Parameters %{#Functions-mapState-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object of state properties or getters | -#### Returns %{#Module:-pinia-Functions-mapState-Returns}% +#### Returns %{#Functions-mapState-Returns}% [`_MapStateObjectReturn`](pinia.md#_mapstateobjectreturn)<`Id`, `S`, `G`, `A`, `KeyMapper`\> @@ -948,7 +947,7 @@ export default { } ``` -#### Type parameters %{#Module:-pinia-Functions-mapState-Type-parameters_1}% +#### Type parameters %{#Functions-mapState-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -958,20 +957,20 @@ export default { | `A` | `A` | | `Keys` | extends `string` \| `number` \| `symbol` | -#### Parameters %{#Module:-pinia-Functions-mapState-Parameters_1}% +#### Parameters %{#Functions-mapState-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | readonly `Keys`[] | array of state properties or getters | -#### Returns %{#Module:-pinia-Functions-mapState-Returns_1}% +#### Returns %{#Functions-mapState-Returns_1}% [`_MapStateReturn`](pinia.md#_mapstatereturn)<`S`, `G`, `Keys`\> ___ -### mapStores %{#Module:-pinia-Functions-mapStores}% +### mapStores %{#Functions-mapStores}% ▸ **mapStores**<`Stores`\>(...`stores`): [`_Spread`](pinia.md#_spread)<`Stores`\> @@ -995,25 +994,25 @@ export default { } ``` -#### Type parameters %{#Module:-pinia-Functions-mapStores-Type-parameters}% +#### Type parameters %{#Functions-mapStores-Type-parameters}% | Name | Type | | :------ | :------ | | `Stores` | extends `any`[] | -#### Parameters %{#Module:-pinia-Functions-mapStores-Parameters}% +#### Parameters %{#Functions-mapStores-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `...stores` | [...Stores[]] | list of stores to map to an object | -#### Returns %{#Module:-pinia-Functions-mapStores-Returns}% +#### Returns %{#Functions-mapStores-Returns}% [`_Spread`](pinia.md#_spread)<`Stores`\> ___ -### mapWritableState %{#Module:-pinia-Functions-mapWritableState}% +### mapWritableState %{#Functions-mapWritableState}% ▸ **mapWritableState**<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> @@ -1021,7 +1020,7 @@ Same as `mapState()` but creates computed setters as well so the state can be modified. Differently from `mapState()`, only `state` properties can be added. -#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters}% +#### Type parameters %{#Functions-mapWritableState-Type-parameters}% | Name | Type | | :------ | :------ | @@ -1031,14 +1030,14 @@ added. | `A` | `A` | | `KeyMapper` | extends `Record`<`string`, keyof `S`\> | -#### Parameters %{#Module:-pinia-Functions-mapWritableState-Parameters}% +#### Parameters %{#Functions-mapWritableState-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keyMapper` | `KeyMapper` | object of state properties | -#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns}% +#### Returns %{#Functions-mapWritableState-Returns}% [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> @@ -1048,7 +1047,7 @@ Allows using state and getters from one store without using the composition API (`setup()`) by generating an object to be spread in the `computed` field of a component. -#### Type parameters %{#Module:-pinia-Functions-mapWritableState-Type-parameters_1}% +#### Type parameters %{#Functions-mapWritableState-Type-parameters_1}% | Name | Type | | :------ | :------ | @@ -1057,39 +1056,39 @@ of a component. | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | -#### Parameters %{#Module:-pinia-Functions-mapWritableState-Parameters_1}% +#### Parameters %{#Functions-mapWritableState-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | | `keys` | keyof `S`[] | array of state properties | -#### Returns %{#Module:-pinia-Functions-mapWritableState-Returns_1}% +#### Returns %{#Functions-mapWritableState-Returns_1}% [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> ___ -### setActivePinia %{#Module:-pinia-Functions-setActivePinia}% +### setActivePinia %{#Functions-setActivePinia}% ▸ **setActivePinia**(`pinia`): `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) Sets or unsets the active pinia. Used in SSR and internally when calling actions and getters -#### Parameters %{#Module:-pinia-Functions-setActivePinia-Parameters}% +#### Parameters %{#Functions-setActivePinia-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `pinia` | `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) | Pinia instance | -#### Returns %{#Module:-pinia-Functions-setActivePinia-Returns}% +#### Returns %{#Functions-setActivePinia-Returns}% `undefined` \| [`Pinia`](../interfaces/pinia.Pinia.md) ___ -### setMapStoreSuffix %{#Module:-pinia-Functions-setMapStoreSuffix}% +### setMapStoreSuffix %{#Functions-setMapStoreSuffix}% ▸ **setMapStoreSuffix**(`suffix`): `void` @@ -1097,38 +1096,38 @@ Changes the suffix added by `mapStores()`. Can be set to an empty string. Defaults to `"Store"`. Make sure to extend the MapStoresCustomization interface if you are using TypeScript. -#### Parameters %{#Module:-pinia-Functions-setMapStoreSuffix-Parameters}% +#### Parameters %{#Functions-setMapStoreSuffix-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `suffix` | `string` | new suffix | -#### Returns %{#Module:-pinia-Functions-setMapStoreSuffix-Returns}% +#### Returns %{#Functions-setMapStoreSuffix-Returns}% `void` ___ -### skipHydrate %{#Module:-pinia-Functions-skipHydrate}% +### skipHydrate %{#Functions-skipHydrate}% ▸ **skipHydrate**<`T`\>(`obj`): `T` Tells Pinia to skip the hydration process of a given object. This is useful in setup stores (only) when you return a stateful object in the store but it isn't really state. e.g. returning a router instance in a setup store. -#### Type parameters %{#Module:-pinia-Functions-skipHydrate-Type-parameters}% +#### Type parameters %{#Functions-skipHydrate-Type-parameters}% | Name | Type | | :------ | :------ | | `T` | `any` | -#### Parameters %{#Module:-pinia-Functions-skipHydrate-Parameters}% +#### Parameters %{#Functions-skipHydrate-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `obj` | `T` | target object | -#### Returns %{#Module:-pinia-Functions-skipHydrate-Returns}% +#### Returns %{#Functions-skipHydrate-Returns}% `T` @@ -1136,7 +1135,7 @@ obj ___ -### storeToRefs %{#Module:-pinia-Functions-storeToRefs}% +### storeToRefs %{#Functions-storeToRefs}% ▸ **storeToRefs**<`SS`\>(`store`): `StoreToRefs`<`SS`\> @@ -1145,18 +1144,18 @@ state properties of the store. Similar to `toRefs()` but specifically designed for Pinia stores so methods and non reactive properties are completely ignored. -#### Type parameters %{#Module:-pinia-Functions-storeToRefs-Type-parameters}% +#### Type parameters %{#Functions-storeToRefs-Type-parameters}% | Name | Type | | :------ | :------ | | `SS` | extends [`_StoreWithState`](../interfaces/pinia._StoreWithState.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree), `SS`\> & [`StateTree`](pinia.md#statetree) & [`_StoreWithGetters`](pinia.md#_storewithgetters)<[`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>\> & [`PiniaCustomProperties`](../interfaces/pinia.PiniaCustomProperties.md)<`string`, [`StateTree`](pinia.md#statetree), [`_GettersTree`](pinia.md#_getterstree)<[`StateTree`](pinia.md#statetree)\>, [`_ActionsTree`](pinia.md#_actionstree), `SS`\> & [`PiniaCustomStateProperties`](../interfaces/pinia.PiniaCustomStateProperties.md)<[`StateTree`](pinia.md#statetree), `SS`\> | -#### Parameters %{#Module:-pinia-Functions-storeToRefs-Parameters}% +#### Parameters %{#Functions-storeToRefs-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `store` | `SS` | store to extract the refs from | -#### Returns %{#Module:-pinia-Functions-storeToRefs-Returns}% +#### Returns %{#Functions-storeToRefs-Returns}% `StoreToRefs`<`SS`\> diff --git a/packages/docs-new/api/modules/pinia_nuxt.md b/packages/docs-new/api/modules/pinia_nuxt.md index ca9184bc..49e6a9cd 100644 --- a/packages/docs-new/api/modules/pinia_nuxt.md +++ b/packages/docs-new/api/modules/pinia_nuxt.md @@ -1,24 +1,24 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / @pinia/nuxt -# Module: @pinia/nuxt %{#Module:-@pinia/nuxt}% +# Module: @pinia/nuxt -## Interfaces %{#Module:-@pinia/nuxt-Interfaces}% +## Interfaces %{#Interfaces}% - [ModuleOptions](../interfaces/pinia_nuxt.ModuleOptions.md) -## Functions %{#Module:-@pinia/nuxt-Functions}% +## Functions %{#Functions}% -### default %{#Module:-@pinia/nuxt-Functions-default}% +### default %{#Functions-default}% ▸ **default**(`this`, `inlineOptions`, `nuxt`): `void` \| `Promise`<`void`\> -#### Parameters %{#Module:-@pinia/nuxt-Functions-default-Parameters}% +#### Parameters %{#Functions-default-Parameters}% | Name | Type | | :------ | :------ | @@ -26,6 +26,6 @@ sidebarDepth: 3 | `inlineOptions` | [`ModuleOptions`](../interfaces/pinia_nuxt.ModuleOptions.md) | | `nuxt` | `Nuxt` | -#### Returns %{#Module:-@pinia/nuxt-Functions-default-Returns}% +#### Returns %{#Functions-default-Returns}% `void` \| `Promise`<`void`\> diff --git a/packages/docs-new/api/modules/pinia_testing.md b/packages/docs-new/api/modules/pinia_testing.md index eba072e4..ba6a09f0 100644 --- a/packages/docs-new/api/modules/pinia_testing.md +++ b/packages/docs-new/api/modules/pinia_testing.md @@ -1,21 +1,21 @@ --- sidebar: "auto" -editLinks: false +editLink: false sidebarDepth: 3 --- [API Documentation](../index.md) / @pinia/testing -# Module: @pinia/testing %{#Module:-@pinia/testing}% +# Module: @pinia/testing -## Interfaces %{#Module:-@pinia/testing-Interfaces}% +## Interfaces %{#Interfaces}% - [TestingOptions](../interfaces/pinia_testing.TestingOptions.md) - [TestingPinia](../interfaces/pinia_testing.TestingPinia.md) -## Functions %{#Module:-@pinia/testing-Functions}% +## Functions %{#Functions}% -### createTestingPinia %{#Module:-@pinia/testing-Functions-createTestingPinia}% +### createTestingPinia %{#Functions-createTestingPinia}% ▸ **createTestingPinia**(`options?`): [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md) @@ -26,13 +26,13 @@ You can change this with the `stubActions` option. If you are using jest, they are replaced with `jest.fn()`, otherwise, you must provide your own `createSpy` option. -#### Parameters %{#Module:-@pinia/testing-Functions-createTestingPinia-Parameters}% +#### Parameters %{#Functions-createTestingPinia-Parameters}% | Name | Type | Description | | :------ | :------ | :------ | | `options` | [`TestingOptions`](../interfaces/pinia_testing.TestingOptions.md) | options to configure the testing pinia | -#### Returns %{#Module:-@pinia/testing-Functions-createTestingPinia-Returns}% +#### Returns %{#Functions-createTestingPinia-Returns}% [`TestingPinia`](../interfaces/pinia_testing.TestingPinia.md) diff --git a/packages/docs-new/package.json b/packages/docs-new/package.json index 7c793e77..d7c61341 100644 --- a/packages/docs-new/package.json +++ b/packages/docs-new/package.json @@ -11,5 +11,6 @@ "@vueuse/core": "^9.5.0", "pinia": "workspace:^2.0.18", "vitepress": "^1.0.0-0" - } + }, + "devDependencies": {} } diff --git a/packages/docs-new/typedoc-markdown.js b/packages/docs-new/typedoc-markdown.js index c94b3c70..3f7df9d2 100644 --- a/packages/docs-new/typedoc-markdown.js +++ b/packages/docs-new/typedoc-markdown.js @@ -50,10 +50,8 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) { (page) => { if (page.url !== 'index.md' && page.contents) { page.contents = prependYAML(page.contents, { - sidebar: 'auto', // TODO: figure out a way to point to the source files? - editLinks: false, - sidebarDepth: 3, + editLink: false, }) } @@ -77,7 +75,11 @@ exports.createTypeDocApp = function createTypeDocApp(config = {}) { titleStack.push(line.slice(level).trim()) currentLevel = level - const slugifiedTitle = slugify(titleStack.join('-')) + // no need to add ids to h1 + if (level < 2) continue + + // ignore the root level (h1) to match the sidebar + const slugifiedTitle = slugify(titleStack.slice(1).join('-')) let id if (existingIds.has(slugifiedTitle)) { const current = existingIds.get(slugifiedTitle)