diff --git a/packages/docs/api/@pinia/nuxt/functions/default.md b/packages/docs/api/@pinia/nuxt/functions/default.md deleted file mode 100644 index d7c1376a62..0000000000 --- a/packages/docs/api/@pinia/nuxt/functions/default.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../../index.md) • **Docs** - -*** - -[API Documentation](../../../index.md) / [@pinia/nuxt](../index.md) / default - -# Function: default() - -> **default**(`this`, `resolvedOptions`, `nuxt`): `ModuleSetupReturn` - -## Parameters - -• **this**: `void` - -• **resolvedOptions**: [`ModuleOptions`](../interfaces/ModuleOptions.md) - -• **nuxt**: `Nuxt` - -## Returns - -`ModuleSetupReturn` diff --git a/packages/docs/api/@pinia/nuxt/index.md b/packages/docs/api/@pinia/nuxt/index.md deleted file mode 100644 index 9779e16beb..0000000000 --- a/packages/docs/api/@pinia/nuxt/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / @pinia/nuxt - -# @pinia/nuxt - -## Index - -### Interfaces - -- [ModuleOptions](interfaces/ModuleOptions.md) - -### Functions - -- [default](functions/default.md) diff --git a/packages/docs/api/@pinia/nuxt/interfaces/ModuleOptions.md b/packages/docs/api/@pinia/nuxt/interfaces/ModuleOptions.md deleted file mode 100644 index 715c6bc328..0000000000 --- a/packages/docs/api/@pinia/nuxt/interfaces/ModuleOptions.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../../index.md) • **Docs** - -*** - -[API Documentation](../../../index.md) / [@pinia/nuxt](../index.md) / ModuleOptions - -# Interface: ModuleOptions - -## Properties - -### disableVuex? - -> `optional` **disableVuex**: `boolean` - -Pinia disables Vuex by default, set this option to `false` to avoid it and -use Pinia alongside Vuex (Nuxt 2 only) - -#### Default - -`true` - -*** - -### storesDirs? - -> `optional` **storesDirs**: `string`[] - -Automatically add stores dirs to the auto imports. This is the same as -directly adding the dirs to the `imports.dirs` option. If you want to -also import nested stores, you can use the glob pattern `./stores/**` - -#### Default - -`['stores']` diff --git a/packages/docs/api/@pinia/testing/functions/createTestingPinia.md b/packages/docs/api/@pinia/testing/functions/createTestingPinia.md deleted file mode 100644 index 916bb1aa29..0000000000 --- a/packages/docs/api/@pinia/testing/functions/createTestingPinia.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../../index.md) • **Docs** - -*** - -[API Documentation](../../../index.md) / [@pinia/testing](../index.md) / createTestingPinia - -# Function: createTestingPinia() - -> **createTestingPinia**(`options`): [`TestingPinia`](../interfaces/TestingPinia.md) - -Creates a pinia instance designed for unit tests that **requires mocking** -the stores. By default, **all actions are mocked** and therefore not -executed. This allows you to unit test your store and components separately. -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 - -• **options**: [`TestingOptions`](../interfaces/TestingOptions.md) = `{}` - -options to configure the testing pinia - -## Returns - -[`TestingPinia`](../interfaces/TestingPinia.md) - -a augmented pinia instance diff --git a/packages/docs/api/@pinia/testing/index.md b/packages/docs/api/@pinia/testing/index.md deleted file mode 100644 index 91c5b083a2..0000000000 --- a/packages/docs/api/@pinia/testing/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / @pinia/testing - -# @pinia/testing - -## Index - -### Interfaces - -- [TestingOptions](interfaces/TestingOptions.md) -- [TestingPinia](interfaces/TestingPinia.md) - -### Functions - -- [createTestingPinia](functions/createTestingPinia.md) diff --git a/packages/docs/api/@pinia/testing/interfaces/TestingOptions.md b/packages/docs/api/@pinia/testing/interfaces/TestingOptions.md deleted file mode 100644 index 333faeb544..0000000000 --- a/packages/docs/api/@pinia/testing/interfaces/TestingOptions.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../../index.md) • **Docs** - -*** - -[API Documentation](../../../index.md) / [@pinia/testing](../index.md) / TestingOptions - -# Interface: TestingOptions - -## Properties - -### createSpy()? - -> `optional` **createSpy**: (`fn`?) => (...`args`) => `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 if -`globals: true` is set. - -#### Parameters - -• **fn?** - -#### Returns - -`Function` - -##### Parameters - -• ...**args**: `any`[] - -##### Returns - -`any` - -*** - -### fakeApp? - -> `optional` **fakeApp**: `boolean` - -Creates an empty App and calls `app.use(pinia)` with the created testing -pinia. This allows you to use plugins while unit testing stores as -plugins **will wait for pinia to be installed in order to be executed**. -Defaults to false. - -*** - -### initialState? - -> `optional` **initialState**: [`StateTree`](../../../pinia/type-aliases/StateTree.md) - -Allows defining a partial initial state of all your stores. This state gets applied after a store is created, -allowing you to only set a few properties that are required in your test. - -*** - -### plugins? - -> `optional` **plugins**: [`PiniaPlugin`](../../../pinia/interfaces/PiniaPlugin.md)[] - -Plugins to be installed before the testing plugin. Add any plugins used in -your application that will be used while testing. - -*** - -### stubActions? - -> `optional` **stubActions**: `boolean` - -When set to false, actions are only spied, but they will still get executed. When -set to true, actions will be replaced with spies, resulting in their code -not being executed. Defaults to true. NOTE: when providing `createSpy()`, -it will **only** make the `fn` argument `undefined`. You still have to -handle this in `createSpy()`. - -*** - -### stubPatch? - -> `optional` **stubPatch**: `boolean` - -When set to true, calls to `$patch()` won't change the state. Defaults to -false. NOTE: when providing `createSpy()`, it will **only** make the `fn` -argument `undefined`. You still have to handle this in `createSpy()`. - -*** - -### stubReset? - -> `optional` **stubReset**: `boolean` - -When set to true, calls to `$reset()` won't change the state. Defaults to -false. diff --git a/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md b/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md deleted file mode 100644 index 1e26372edc..0000000000 --- a/packages/docs/api/@pinia/testing/interfaces/TestingPinia.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../../index.md) • **Docs** - -*** - -[API Documentation](../../../index.md) / [@pinia/testing](../index.md) / TestingPinia - -# Interface: TestingPinia - -Pinia instance specifically designed for testing. Extends a regular -`Pinia` instance with test specific properties. - -## Extends - -- [`Pinia`](../../../pinia/interfaces/Pinia.md) - -## Properties - -### app - -> **app**: `App`\<`any`\> - -App used by Pinia - -*** - -### install() - -> **install**: (`app`) => `void` - -#### Parameters - -• **app**: `App`\<`any`\> - -#### Returns - -`void` - -#### Inherited from - -[`Pinia`](../../../pinia/interfaces/Pinia.md).[`install`](../../../pinia/interfaces/Pinia.md#install) - -*** - -### state - -> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../../../pinia/type-aliases/StateTree.md)\>\> - -root state - -#### Inherited from - -[`Pinia`](../../../pinia/interfaces/Pinia.md).[`state`](../../../pinia/interfaces/Pinia.md#state) - -## Methods - -### use() - -> **use**(`plugin`): [`Pinia`](../../../pinia/interfaces/Pinia.md) - -Adds a store plugin to extend every store - -#### Parameters - -• **plugin**: [`PiniaPlugin`](../../../pinia/interfaces/PiniaPlugin.md) - -store plugin to add - -#### Returns - -[`Pinia`](../../../pinia/interfaces/Pinia.md) - -#### Inherited from - -[`Pinia`](../../../pinia/interfaces/Pinia.md).[`use`](../../../pinia/interfaces/Pinia.md#use) diff --git a/packages/docs/api/index.md b/packages/docs/api/index.md deleted file mode 100644 index 100f354c07..0000000000 --- a/packages/docs/api/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -editLink: false ---- - -**API Documentation** • **Docs** - -*** - -# API Documentation - -## Modules - -- [@pinia/nuxt](@pinia/nuxt/index.md) -- [@pinia/testing](@pinia/testing/index.md) -- [pinia](pinia/index.md) diff --git a/packages/docs/api/pinia/enumerations/MutationType.md b/packages/docs/api/pinia/enumerations/MutationType.md deleted file mode 100644 index 6533c3a217..0000000000 --- a/packages/docs/api/pinia/enumerations/MutationType.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / MutationType - -# Enumeration: MutationType - -Possible types for SubscriptionCallback - -## Enumeration Members - -### direct - -> **direct**: `"direct"` - -Direct mutation of the state: - -- `store.name = 'new name'` -- `store.$state.name = 'new name'` -- `store.list.push('new item')` - -*** - -### patchFunction - -> **patchFunction**: `"patch function"` - -Mutated the state with `$patch` and a function - -- `store.$patch(state => state.name = 'newName')` - -*** - -### patchObject - -> **patchObject**: `"patch object"` - -Mutated the state with `$patch` and an object - -- `store.$patch({ name: 'newName' })` diff --git a/packages/docs/api/pinia/functions/acceptHMRUpdate.md b/packages/docs/api/pinia/functions/acceptHMRUpdate.md deleted file mode 100644 index b57f60816b..0000000000 --- a/packages/docs/api/pinia/functions/acceptHMRUpdate.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / acceptHMRUpdate - -# Function: acceptHMRUpdate() - -> **acceptHMRUpdate**\<`Id`, `S`, `G`, `A`\>(`initialUseStore`, `hot`): (`newModule`) => `any` - -Creates an _accept_ function to pass to `import.meta.hot` in Vite applications. - -## Type Parameters - -• **Id** *extends* `string` = `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> = [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** = [`_ActionsTree`](../type-aliases/ActionsTree.md) - -## Parameters - -• **initialUseStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -return of the defineStore to hot update - -• **hot**: `any` - -`import.meta.hot` - -## Returns - -`Function` - -### Parameters - -• **newModule**: `any` - -### Returns - -`any` - -## Example - -```js -const useUser = defineStore(...) -if (import.meta.hot) { - import.meta.hot.accept(acceptHMRUpdate(useUser, import.meta.hot)) -} -``` diff --git a/packages/docs/api/pinia/functions/createPinia.md b/packages/docs/api/pinia/functions/createPinia.md deleted file mode 100644 index 4f6e303e5c..0000000000 --- a/packages/docs/api/pinia/functions/createPinia.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / createPinia - -# Function: createPinia() - -> **createPinia**(): [`Pinia`](../interfaces/Pinia.md) - -Creates a Pinia instance to be used by the application - -## Returns - -[`Pinia`](../interfaces/Pinia.md) diff --git a/packages/docs/api/pinia/functions/defineStore.md b/packages/docs/api/pinia/functions/defineStore.md deleted file mode 100644 index 42e6e8d1a2..0000000000 --- a/packages/docs/api/pinia/functions/defineStore.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / defineStore - -# Function: defineStore() - -## defineStore(id, options) - -> **defineStore**\<`Id`, `S`, `G`, `A`\>(`id`, `options`): [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -Creates a `useStore` function that retrieves the store instance - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = `object` - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> = `object` - -• **A** = `object` - -### Parameters - -• **id**: `Id` - -id of the store (must be unique) - -• **options**: `Omit`\<[`DefineStoreOptions`](../interfaces/DefineStoreOptions.md)\<`Id`, `S`, `G`, `A`\>, `"id"`\> - -options to define the store - -### Returns - -[`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -## defineStore(options) - -> **defineStore**\<`Id`, `S`, `G`, `A`\>(`options`): [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -Creates a `useStore` function that retrieves the store instance - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = `object` - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> = `object` - -• **A** = `object` - -### Parameters - -• **options**: [`DefineStoreOptions`](../interfaces/DefineStoreOptions.md)\<`Id`, `S`, `G`, `A`\> - -options to define the store - -### Returns - -[`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -## defineStore(id, storeSetup, options) - -> **defineStore**\<`Id`, `SS`\>(`id`, `storeSetup`, `options`?): [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> - -Creates a `useStore` function that retrieves the store instance - -### Type Parameters - -• **Id** *extends* `string` - -• **SS** - -### Parameters - -• **id**: `Id` - -id of the store (must be unique) - -• **storeSetup** - -function that defines the store - -• **options?**: [`DefineSetupStoreOptions`](../interfaces/DefineSetupStoreOptions.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> - -extra options - -### Returns - -[`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> diff --git a/packages/docs/api/pinia/functions/disposePinia.md b/packages/docs/api/pinia/functions/disposePinia.md deleted file mode 100644 index a71007ba1a..0000000000 --- a/packages/docs/api/pinia/functions/disposePinia.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / disposePinia - -# Function: disposePinia() - -> **disposePinia**(`pinia`): `void` - -Dispose a Pinia instance by stopping its effectScope and removing the state, plugins and stores. This is mostly -useful in tests, with both a testing pinia or a regular pinia and in applications that use multiple pinia instances. -Once disposed, the pinia instance cannot be used anymore. - -## Parameters - -• **pinia**: [`Pinia`](../interfaces/Pinia.md) - -pinia instance - -## Returns - -`void` diff --git a/packages/docs/api/pinia/functions/getActivePinia.md b/packages/docs/api/pinia/functions/getActivePinia.md deleted file mode 100644 index 5a7922506a..0000000000 --- a/packages/docs/api/pinia/functions/getActivePinia.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / getActivePinia - -# Function: getActivePinia() - -> **getActivePinia**(): `undefined` \| [`Pinia`](../interfaces/Pinia.md) - -Get the currently active pinia if there is any. - -## Returns - -`undefined` \| [`Pinia`](../interfaces/Pinia.md) diff --git a/packages/docs/api/pinia/functions/mapActions.md b/packages/docs/api/pinia/functions/mapActions.md deleted file mode 100644 index 927e272bff..0000000000 --- a/packages/docs/api/pinia/functions/mapActions.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / mapActions - -# Function: mapActions() - -Allows directly using actions from your store without using the composition -API (`setup()`) by generating an object to be spread in the `methods` field -of a component. - -## Param - -store to map from - -## Param - -array or object - -## mapActions(useStore, keyMapper) - -> **mapActions**\<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapActionsObjectReturn`](../type-aliases/MapActionsObjectReturn.md)\<`A`, `KeyMapper`\> - -Allows directly using actions from your store without using the composition -API (`setup()`) by generating an object to be spread in the `methods` field -of a component. The values of the object are the actions while the keys are -the names of the resulting methods. - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** - -• **KeyMapper** *extends* `Record`\<`string`, keyof `A`\> - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keyMapper**: `KeyMapper` - -object to define new names for the actions - -### Returns - -[`_MapActionsObjectReturn`](../type-aliases/MapActionsObjectReturn.md)\<`A`, `KeyMapper`\> - -### Param - -store to map from - -### Param - -array or object - -### Example - -```js -export default { - methods: { - // other methods properties - // useCounterStore has two actions named `increment` and `setCount` - ...mapActions(useCounterStore, { more: 'increment', setIt: 'setCount' }) - }, - - created() { - this.more() - this.setIt(2) - } -} -``` - -## mapActions(useStore, keys) - -> **mapActions**\<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapActionsReturn`](../type-aliases/MapActionsReturn.md)\<`A`\> - -Allows directly using actions from your store without using the composition -API (`setup()`) by generating an object to be spread in the `methods` field -of a component. - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keys**: keyof `A`[] - -array of action names to map - -### Returns - -[`_MapActionsReturn`](../type-aliases/MapActionsReturn.md)\<`A`\> - -### Param - -store to map from - -### Param - -array or object - -### Example - -```js -export default { - methods: { - // other methods properties - ...mapActions(useCounterStore, ['increment', 'setCount']) - }, - - created() { - this.increment() - this.setCount(2) // pass arguments as usual - } -} -``` diff --git a/packages/docs/api/pinia/functions/mapGetters.md b/packages/docs/api/pinia/functions/mapGetters.md deleted file mode 100644 index 75fe09bd1d..0000000000 --- a/packages/docs/api/pinia/functions/mapGetters.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / mapGetters - -# Function: ~~mapGetters()~~ - -Alias for `mapState()`. You should use `mapState()` instead. - -## Deprecated - -use `mapState()` instead. - -## mapGetters(useStore, keyMapper) - -> **mapGetters**\<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](../type-aliases/MapStateObjectReturn.md)\<`Id`, `S`, `G`, `A`, `KeyMapper`\> - -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. The values of the object are the state properties/getters -while the keys are the names of the resulting computed properties. -Optionally, you can also pass a custom function that will receive the store -as its first argument. Note that while it has access to the component -instance via `this`, it won't be typed. - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> \| `object` - -• **A** - -• **KeyMapper** *extends* `Record`\<`string`, keyof `S` \| keyof `G` \| (`store`) => `any`\> - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keyMapper**: `KeyMapper` - -object of state properties or getters - -### Returns - -[`_MapStateObjectReturn`](../type-aliases/MapStateObjectReturn.md)\<`Id`, `S`, `G`, `A`, `KeyMapper`\> - -### Deprecated - -use `mapState()` instead. - -### Example - -```js -export default { - computed: { - // other computed properties - // useCounterStore has a state property named `count` and a getter `double` - ...mapState(useCounterStore, { - n: 'count', - triple: store => store.n * 3, - // note we can't use an arrow function if we want to use `this` - custom(store) { - return this.someComponentValue + store.n - }, - doubleN: 'double' - }) - }, - - created() { - this.n // 2 - this.doubleN // 4 - } -} -``` - -## mapGetters(useStore, keys) - -> **mapGetters**\<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](../type-aliases/MapStateReturn.md)\<`S`, `G`, `Keys`\> - -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 - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> \| `object` - -• **A** - -• **Keys** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keys**: readonly `Keys`[] - -array of state properties or getters - -### Returns - -[`_MapStateReturn`](../type-aliases/MapStateReturn.md)\<`S`, `G`, `Keys`\> - -### Deprecated - -use `mapState()` instead. - -### Example - -```js -export default { - computed: { - // other computed properties - ...mapState(useCounterStore, ['count', 'double']) - }, - - created() { - this.count // 2 - this.double // 4 - } -} -``` diff --git a/packages/docs/api/pinia/functions/mapState.md b/packages/docs/api/pinia/functions/mapState.md deleted file mode 100644 index 17983169a3..0000000000 --- a/packages/docs/api/pinia/functions/mapState.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / mapState - -# Function: mapState() - -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. - -## Param - -store to map from - -## Param - -array or object - -## mapState(useStore, keyMapper) - -> **mapState**\<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapStateObjectReturn`](../type-aliases/MapStateObjectReturn.md)\<`Id`, `S`, `G`, `A`, `KeyMapper`\> - -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. The values of the object are the state properties/getters -while the keys are the names of the resulting computed properties. -Optionally, you can also pass a custom function that will receive the store -as its first argument. Note that while it has access to the component -instance via `this`, it won't be typed. - -### Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> \| `object` - -• **A** - -• **KeyMapper** *extends* `Record`\<`string`, keyof `S` \| keyof `G` \| (`store`) => `any`\> - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keyMapper**: `KeyMapper` - -object of state properties or getters - -### Returns - -[`_MapStateObjectReturn`](../type-aliases/MapStateObjectReturn.md)\<`Id`, `S`, `G`, `A`, `KeyMapper`\> - -### Param - -store to map from - -### Param - -array or object - -### Example - -```js -export default { - computed: { - // other computed properties - // useCounterStore has a state property named `count` and a getter `double` - ...mapState(useCounterStore, { - n: 'count', - triple: store => store.n * 3, - // note we can't use an arrow function if we want to use `this` - custom(store) { - return this.someComponentValue + store.n - }, - doubleN: 'double' - }) - }, - - created() { - this.n // 2 - this.doubleN // 4 - } -} -``` - -## mapState(useStore, keys) - -> **mapState**\<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): [`_MapStateReturn`](../type-aliases/MapStateReturn.md)\<`S`, `G`, `Keys`\> - -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 - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> \| `object` - -• **A** - -• **Keys** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keys**: readonly `Keys`[] - -array of state properties or getters - -### Returns - -[`_MapStateReturn`](../type-aliases/MapStateReturn.md)\<`S`, `G`, `Keys`\> - -### Param - -store to map from - -### Param - -array or object - -### Example - -```js -export default { - computed: { - // other computed properties - ...mapState(useCounterStore, ['count', 'double']) - }, - - created() { - this.count // 2 - this.double // 4 - } -} -``` diff --git a/packages/docs/api/pinia/functions/mapStores.md b/packages/docs/api/pinia/functions/mapStores.md deleted file mode 100644 index dda50915da..0000000000 --- a/packages/docs/api/pinia/functions/mapStores.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / mapStores - -# Function: mapStores() - -> **mapStores**\<`Stores`\>(...`stores`): [`_Spread`](../type-aliases/Spread.md)\<`Stores`\> - -Allows using stores without the composition API (`setup()`) by generating an -object to be spread in the `computed` field of a component. It accepts a list -of store definitions. - -## Type Parameters - -• **Stores** *extends* `any`[] - -## Parameters - -• ...**stores**: [`...Stores[]`] - -list of stores to map to an object - -## Returns - -[`_Spread`](../type-aliases/Spread.md)\<`Stores`\> - -## Example - -```js -export default { - computed: { - // other computed properties - ...mapStores(useUserStore, useCartStore) - }, - - created() { - this.userStore // store with id "user" - this.cartStore // store with id "cart" - } -} -``` diff --git a/packages/docs/api/pinia/functions/mapWritableState.md b/packages/docs/api/pinia/functions/mapWritableState.md deleted file mode 100644 index c8b572d022..0000000000 --- a/packages/docs/api/pinia/functions/mapWritableState.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / mapWritableState - -# Function: mapWritableState() - -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. - -## Param - -store to map from - -## Param - -array or object - -## mapWritableState(useStore, keyMapper) - -> **mapWritableState**\<`Id`, `S`, `G`, `A`, `KeyMapper`\>(`useStore`, `keyMapper`): [`_MapWritableStateObjectReturn`](../type-aliases/MapWritableStateObjectReturn.md)\<`S`, `KeyMapper`\> - -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 - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** - -• **KeyMapper** *extends* `Record`\<`string`, keyof `S`\> - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keyMapper**: `KeyMapper` - -object of state properties - -### Returns - -[`_MapWritableStateObjectReturn`](../type-aliases/MapWritableStateObjectReturn.md)\<`S`, `KeyMapper`\> - -### Param - -store to map from - -### Param - -array or object - -## mapWritableState(useStore, keys) - -> **mapWritableState**\<`Id`, `S`, `G`, `A`, `Keys`\>(`useStore`, `keys`): `{ [K in Keys]: Object }` - -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 - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** *extends* [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** - -• **Keys** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **useStore**: [`StoreDefinition`](../interfaces/StoreDefinition.md)\<`Id`, `S`, `G`, `A`\> - -store to map from - -• **keys**: readonly `Keys`[] - -array of state properties - -### Returns - -`{ [K in Keys]: Object }` - -### Param - -store to map from - -### Param - -array or object diff --git a/packages/docs/api/pinia/functions/setActivePinia.md b/packages/docs/api/pinia/functions/setActivePinia.md deleted file mode 100644 index 1d97b0302e..0000000000 --- a/packages/docs/api/pinia/functions/setActivePinia.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / setActivePinia - -# Function: setActivePinia() - -Sets or unsets the active pinia. Used in SSR and internally when calling -actions and getters - -## Param - -Pinia instance - -## setActivePinia(pinia) - -> **setActivePinia**(`pinia`): [`Pinia`](../interfaces/Pinia.md) - -Sets or unsets the active pinia. Used in SSR and internally when calling -actions and getters - -### Parameters - -• **pinia**: [`Pinia`](../interfaces/Pinia.md) - -### Returns - -[`Pinia`](../interfaces/Pinia.md) - -### Param - -Pinia instance - -## setActivePinia(pinia) - -> **setActivePinia**(`pinia`): `undefined` - -Sets or unsets the active pinia. Used in SSR and internally when calling -actions and getters - -### Parameters - -• **pinia**: `undefined` - -### Returns - -`undefined` - -### Param - -Pinia instance - -## setActivePinia(pinia) - -> **setActivePinia**(`pinia`): `undefined` \| [`Pinia`](../interfaces/Pinia.md) - -Sets or unsets the active pinia. Used in SSR and internally when calling -actions and getters - -### Parameters - -• **pinia**: `undefined` \| [`Pinia`](../interfaces/Pinia.md) - -### Returns - -`undefined` \| [`Pinia`](../interfaces/Pinia.md) - -### Param - -Pinia instance diff --git a/packages/docs/api/pinia/functions/setMapStoreSuffix.md b/packages/docs/api/pinia/functions/setMapStoreSuffix.md deleted file mode 100644 index ae2a5b56a1..0000000000 --- a/packages/docs/api/pinia/functions/setMapStoreSuffix.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / setMapStoreSuffix - -# Function: setMapStoreSuffix() - -> **setMapStoreSuffix**(`suffix`): `void` - -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 - -• **suffix**: `string` - -new suffix - -## Returns - -`void` diff --git a/packages/docs/api/pinia/functions/skipHydrate.md b/packages/docs/api/pinia/functions/skipHydrate.md deleted file mode 100644 index 6ccbf2952e..0000000000 --- a/packages/docs/api/pinia/functions/skipHydrate.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / skipHydrate - -# Function: 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 - -• **T** = `any` - -## Parameters - -• **obj**: `T` - -target object - -## Returns - -`T` - -obj diff --git a/packages/docs/api/pinia/functions/storeToRefs.md b/packages/docs/api/pinia/functions/storeToRefs.md deleted file mode 100644 index 57851c64a4..0000000000 --- a/packages/docs/api/pinia/functions/storeToRefs.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / storeToRefs - -# Function: storeToRefs() - -> **storeToRefs**\<`SS`\>(`store`): `StoreToRefs`\<`SS`\> - -Creates an object of references with all the state, getters, and plugin-added -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 - -• **SS** *extends* [`StoreGeneric`](../type-aliases/StoreGeneric.md) - -## Parameters - -• **store**: `SS` - -store to extract the refs from - -## Returns - -`StoreToRefs`\<`SS`\> diff --git a/packages/docs/api/pinia/index.md b/packages/docs/api/pinia/index.md deleted file mode 100644 index fc1eb1e654..0000000000 --- a/packages/docs/api/pinia/index.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../index.md) • **Docs** - -*** - -[API Documentation](../index.md) / pinia - -# pinia - -## Index - -### Enumerations - -- [MutationType](enumerations/MutationType.md) - -### Interfaces - -- [\_StoreOnActionListenerContext](interfaces/StoreOnActionListenerContext.md) -- [\_StoreWithState](interfaces/StoreWithState.md) -- [\_SubscriptionCallbackMutationBase](interfaces/SubscriptionCallbackMutationBase.md) -- [DefineSetupStoreOptions](interfaces/DefineSetupStoreOptions.md) -- [DefineStoreOptions](interfaces/DefineStoreOptions.md) -- [DefineStoreOptionsBase](interfaces/DefineStoreOptionsBase.md) -- [DefineStoreOptionsInPlugin](interfaces/DefineStoreOptionsInPlugin.md) -- [MapStoresCustomization](interfaces/MapStoresCustomization.md) -- [Pinia](interfaces/Pinia.md) -- [PiniaCustomProperties](interfaces/PiniaCustomProperties.md) -- [PiniaCustomStateProperties](interfaces/PiniaCustomStateProperties.md) -- [PiniaPlugin](interfaces/PiniaPlugin.md) -- [PiniaPluginContext](interfaces/PiniaPluginContext.md) -- [SetupStoreDefinition](interfaces/SetupStoreDefinition.md) -- [StoreDefinition](interfaces/StoreDefinition.md) -- [StoreProperties](interfaces/StoreProperties.md) -- [SubscriptionCallbackMutationDirect](interfaces/SubscriptionCallbackMutationDirect.md) -- [SubscriptionCallbackMutationPatchFunction](interfaces/SubscriptionCallbackMutationPatchFunction.md) -- [SubscriptionCallbackMutationPatchObject](interfaces/SubscriptionCallbackMutationPatchObject.md) - -### Type Aliases - -- [\_ActionsTree](type-aliases/ActionsTree.md) -- [\_Awaited](type-aliases/Awaited.md) -- [\_DeepPartial](type-aliases/DeepPartial.md) -- [\_ExtractActionsFromSetupStore](type-aliases/ExtractActionsFromSetupStore.md) -- [\_ExtractActionsFromSetupStore\_Keys](type-aliases/ExtractActionsFromSetupStore_Keys.md) -- [\_ExtractGettersFromSetupStore](type-aliases/ExtractGettersFromSetupStore.md) -- [\_ExtractGettersFromSetupStore\_Keys](type-aliases/ExtractGettersFromSetupStore_Keys.md) -- [\_ExtractStateFromSetupStore](type-aliases/ExtractStateFromSetupStore.md) -- [\_ExtractStateFromSetupStore\_Keys](type-aliases/ExtractStateFromSetupStore_Keys.md) -- [\_GettersTree](type-aliases/GettersTree.md) -- [\_MapActionsObjectReturn](type-aliases/MapActionsObjectReturn.md) -- [\_MapActionsReturn](type-aliases/MapActionsReturn.md) -- [\_MapStateObjectReturn](type-aliases/MapStateObjectReturn.md) -- [\_MapStateReturn](type-aliases/MapStateReturn.md) -- [\_MapWritableStateObjectReturn](type-aliases/MapWritableStateObjectReturn.md) -- [\_MapWritableStateReturn](type-aliases/MapWritableStateReturn.md) -- [\_Method](type-aliases/Method.md) -- [\_Spread](type-aliases/Spread.md) -- [\_StoreObject](type-aliases/StoreObject.md) -- [\_StoreWithActions](type-aliases/StoreWithActions.md) -- [\_StoreWithGetters](type-aliases/StoreWithGetters.md) -- [\_UnwrapAll](type-aliases/UnwrapAll.md) -- [PiniaStorePlugin](type-aliases/PiniaStorePlugin.md) -- [StateTree](type-aliases/StateTree.md) -- [Store](type-aliases/Store.md) -- [StoreActions](type-aliases/StoreActions.md) -- [StoreGeneric](type-aliases/StoreGeneric.md) -- [StoreGetters](type-aliases/StoreGetters.md) -- [StoreOnActionListener](type-aliases/StoreOnActionListener.md) -- [StoreOnActionListenerContext](type-aliases/StoreOnActionListenerContext.md) -- [StoreState](type-aliases/StoreState.md) -- [SubscriptionCallback](type-aliases/SubscriptionCallback.md) -- [SubscriptionCallbackMutation](type-aliases/SubscriptionCallbackMutation.md) - -### Variables - -- [PiniaVuePlugin](variables/PiniaVuePlugin.md) - -### Functions - -- [acceptHMRUpdate](functions/acceptHMRUpdate.md) -- [createPinia](functions/createPinia.md) -- [defineStore](functions/defineStore.md) -- [disposePinia](functions/disposePinia.md) -- [getActivePinia](functions/getActivePinia.md) -- [mapActions](functions/mapActions.md) -- [mapGetters](functions/mapGetters.md) -- [mapState](functions/mapState.md) -- [mapStores](functions/mapStores.md) -- [mapWritableState](functions/mapWritableState.md) -- [setActivePinia](functions/setActivePinia.md) -- [setMapStoreSuffix](functions/setMapStoreSuffix.md) -- [shouldHydrate](functions/shouldHydrate.md) -- [skipHydrate](functions/skipHydrate.md) -- [storeToRefs](functions/storeToRefs.md) diff --git a/packages/docs/api/pinia/interfaces/DefineSetupStoreOptions.md b/packages/docs/api/pinia/interfaces/DefineSetupStoreOptions.md deleted file mode 100644 index 4ae0bd1fc1..0000000000 --- a/packages/docs/api/pinia/interfaces/DefineSetupStoreOptions.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / DefineSetupStoreOptions - -# Interface: DefineSetupStoreOptions\ - -Options parameter of `defineStore()` for setup stores. Can be extended to -augment stores with the plugin API. - -## See - -[DefineStoreOptionsBase](DefineStoreOptionsBase.md). - -## Extends - -- [`DefineStoreOptionsBase`](DefineStoreOptionsBase.md)\<`S`, [`Store`](../type-aliases/Store.md)\<`Id`, `S`, `G`, `A`\>\> - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** - -• **A** - -## Properties - -### actions? - -> `optional` **actions**: `A` - -Extracted actions. Added by useStore(). SHOULD NOT be added by the user when -creating the store. Can be used in plugins to get the list of actions in a -store defined with a setup function. Note this is always defined diff --git a/packages/docs/api/pinia/interfaces/DefineStoreOptions.md b/packages/docs/api/pinia/interfaces/DefineStoreOptions.md deleted file mode 100644 index c1090d319f..0000000000 --- a/packages/docs/api/pinia/interfaces/DefineStoreOptions.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / DefineStoreOptions - -# Interface: DefineStoreOptions\ - -Options parameter of `defineStore()` for option stores. Can be extended to -augment stores with the plugin API. - -## See - -[DefineStoreOptionsBase](DefineStoreOptionsBase.md). - -## Extends - -- [`DefineStoreOptionsBase`](DefineStoreOptionsBase.md)\<`S`, [`Store`](../type-aliases/Store.md)\<`Id`, `S`, `G`, `A`\>\> - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** - -• **A** - -## Properties - -### actions? - -> `optional` **actions**: `A` & `ThisType`\<`A` & `UnwrapRef`\<`S`\> & [`_StoreWithState`](StoreWithState.md)\<`Id`, `S`, `G`, `A`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> - -Optional object of actions. - -*** - -### getters? - -> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -Optional object of getters. - -*** - -### id - -> **id**: `Id` - -Unique string key to identify the store across the application. - -*** - -### state()? - -> `optional` **state**: () => `S` - -Function to create a fresh state. **Must be an arrow function** to ensure -correct typings! - -#### Returns - -`S` - -## Methods - -### hydrate()? - -> `optional` **hydrate**(`storeState`, `initialState`): `void` - -Allows hydrating the store during SSR when complex state (like client side only refs) are used in the store -definition and copying the value from `pinia.state` isn't enough. - -#### Parameters - -• **storeState**: `UnwrapRef`\<`S`\> - -the current state in the store - -• **initialState**: `UnwrapRef`\<`S`\> - -initialState - -#### Returns - -`void` - -#### Example - -If in your `state`, you use any `customRef`s, any `computed`s, or any `ref`s that have a different value on -Server and Client, you need to manually hydrate them. e.g., a custom ref that is stored in the local -storage: - -```ts -const useStore = defineStore('main', { - state: () => ({ - n: useLocalStorage('key', 0) - }), - hydrate(storeState, initialState) { - // @ts-expect-error: https://github.com/microsoft/TypeScript/issues/43826 - storeState.n = useLocalStorage('key', 0) - } -}) -``` diff --git a/packages/docs/api/pinia/interfaces/DefineStoreOptionsBase.md b/packages/docs/api/pinia/interfaces/DefineStoreOptionsBase.md deleted file mode 100644 index 21df47fe19..0000000000 --- a/packages/docs/api/pinia/interfaces/DefineStoreOptionsBase.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / DefineStoreOptionsBase - -# Interface: DefineStoreOptionsBase\ - -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. - -## Extended by - -- [`DefineStoreOptions`](DefineStoreOptions.md) -- [`DefineSetupStoreOptions`](DefineSetupStoreOptions.md) - -## Type Parameters - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **Store** diff --git a/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md b/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md deleted file mode 100644 index 21996b5f16..0000000000 --- a/packages/docs/api/pinia/interfaces/DefineStoreOptionsInPlugin.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / DefineStoreOptionsInPlugin - -# Interface: DefineStoreOptionsInPlugin\ - -Available `options` when creating a pinia plugin. - -## Extends - -- `Omit`\<[`DefineStoreOptions`](DefineStoreOptions.md)\<`Id`, `S`, `G`, `A`\>, `"id"` \| `"actions"`\> - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** - -• **A** - -## Properties - -### actions - -> **actions**: `A` - -Extracted object of actions. Added by useStore() when the store is built -using the setup API, otherwise uses the one passed to `defineStore()`. -Defaults to an empty object if no actions are defined. - -*** - -### getters? - -> `optional` **getters**: `G` & `ThisType`\<`UnwrapRef`\<`S`\> & `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> & [`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\>\> & [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -Optional object of getters. - -#### Inherited from - -`Omit.getters` - -*** - -### state()? - -> `optional` **state**: () => `S` - -Function to create a fresh state. **Must be an arrow function** to ensure -correct typings! - -#### Returns - -`S` - -#### Inherited from - -`Omit.state` - -## Methods - -### hydrate()? - -> `optional` **hydrate**(`storeState`, `initialState`): `void` - -Allows hydrating the store during SSR when complex state (like client side only refs) are used in the store -definition and copying the value from `pinia.state` isn't enough. - -#### Parameters - -• **storeState**: `UnwrapRef`\<`S`\> - -the current state in the store - -• **initialState**: `UnwrapRef`\<`S`\> - -initialState - -#### Returns - -`void` - -#### Example - -If in your `state`, you use any `customRef`s, any `computed`s, or any `ref`s that have a different value on -Server and Client, you need to manually hydrate them. e.g., a custom ref that is stored in the local -storage: - -```ts -const useStore = defineStore('main', { - state: () => ({ - n: useLocalStorage('key', 0) - }), - hydrate(storeState, initialState) { - // @ts-expect-error: https://github.com/microsoft/TypeScript/issues/43826 - storeState.n = useLocalStorage('key', 0) - } -}) -``` - -#### Inherited from - -`Omit.hydrate` diff --git a/packages/docs/api/pinia/interfaces/MapStoresCustomization.md b/packages/docs/api/pinia/interfaces/MapStoresCustomization.md deleted file mode 100644 index 066fb30504..0000000000 --- a/packages/docs/api/pinia/interfaces/MapStoresCustomization.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / MapStoresCustomization - -# Interface: MapStoresCustomization - -Interface to allow customizing map helpers. Extend this interface with the -following properties: - -- `suffix`: string. Affects the suffix of `mapStores()`, defaults to `Store`. diff --git a/packages/docs/api/pinia/interfaces/Pinia.md b/packages/docs/api/pinia/interfaces/Pinia.md deleted file mode 100644 index 190c5d066b..0000000000 --- a/packages/docs/api/pinia/interfaces/Pinia.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / Pinia - -# Interface: Pinia - -Every application must own its own pinia to be able to create stores - -## Extended by - -- [`TestingPinia`](../../@pinia/testing/interfaces/TestingPinia.md) - -## Properties - -### install() - -> **install**: (`app`) => `void` - -#### Parameters - -• **app**: `App`\<`any`\> - -#### Returns - -`void` - -*** - -### state - -> **state**: `Ref`\<`Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>, `Record`\<`string`, [`StateTree`](../type-aliases/StateTree.md)\>\> - -root state - -## Methods - -### use() - -> **use**(`plugin`): [`Pinia`](Pinia.md) - -Adds a store plugin to extend every store - -#### Parameters - -• **plugin**: [`PiniaPlugin`](PiniaPlugin.md) - -store plugin to add - -#### Returns - -[`Pinia`](Pinia.md) diff --git a/packages/docs/api/pinia/interfaces/PiniaCustomProperties.md b/packages/docs/api/pinia/interfaces/PiniaCustomProperties.md deleted file mode 100644 index 3fd6fd3c50..0000000000 --- a/packages/docs/api/pinia/interfaces/PiniaCustomProperties.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaCustomProperties - -# Interface: PiniaCustomProperties\ - -Interface to be extended by the user when they add properties through plugins. - -## Type Parameters - -• **Id** *extends* `string` = `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = [`StateTree`](../type-aliases/StateTree.md) - -• **G** = [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** = [`_ActionsTree`](../type-aliases/ActionsTree.md) diff --git a/packages/docs/api/pinia/interfaces/PiniaCustomStateProperties.md b/packages/docs/api/pinia/interfaces/PiniaCustomStateProperties.md deleted file mode 100644 index 9d9338aad7..0000000000 --- a/packages/docs/api/pinia/interfaces/PiniaCustomStateProperties.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaCustomStateProperties - -# Interface: PiniaCustomStateProperties\ - -Properties that are added to every `store.$state` by `pinia.use()`. - -## Type Parameters - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = [`StateTree`](../type-aliases/StateTree.md) diff --git a/packages/docs/api/pinia/interfaces/PiniaPlugin.md b/packages/docs/api/pinia/interfaces/PiniaPlugin.md deleted file mode 100644 index 598048351d..0000000000 --- a/packages/docs/api/pinia/interfaces/PiniaPlugin.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaPlugin - -# Interface: PiniaPlugin() - -Plugin to extend every store. - -> **PiniaPlugin**(`context`): `void` \| `Partial`\<[`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\> & [`PiniaCustomStateProperties`](PiniaCustomStateProperties.md)\<[`StateTree`](../type-aliases/StateTree.md)\>\> - -Plugin to extend every store. - -## Parameters - -• **context**: [`PiniaPluginContext`](PiniaPluginContext.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\> - -Context - -## Returns - -`void` \| `Partial`\<[`PiniaCustomProperties`](PiniaCustomProperties.md)\<`string`, [`StateTree`](../type-aliases/StateTree.md), [`_GettersTree`](../type-aliases/GettersTree.md)\<[`StateTree`](../type-aliases/StateTree.md)\>, [`_ActionsTree`](../type-aliases/ActionsTree.md)\> & [`PiniaCustomStateProperties`](PiniaCustomStateProperties.md)\<[`StateTree`](../type-aliases/StateTree.md)\>\> diff --git a/packages/docs/api/pinia/interfaces/PiniaPluginContext.md b/packages/docs/api/pinia/interfaces/PiniaPluginContext.md deleted file mode 100644 index 5df66719d9..0000000000 --- a/packages/docs/api/pinia/interfaces/PiniaPluginContext.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaPluginContext - -# Interface: PiniaPluginContext\ - -Context argument passed to Pinia plugins. - -## Type Parameters - -• **Id** *extends* `string` = `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = [`StateTree`](../type-aliases/StateTree.md) - -• **G** = [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** = [`_ActionsTree`](../type-aliases/ActionsTree.md) - -## Properties - -### app - -> **app**: `App`\<`any`\> - -Current app created with `Vue.createApp()`. - -*** - -### options - -> **options**: [`DefineStoreOptionsInPlugin`](DefineStoreOptionsInPlugin.md)\<`Id`, `S`, `G`, `A`\> - -Initial options defining the store when calling `defineStore()`. - -*** - -### pinia - -> **pinia**: [`Pinia`](Pinia.md) - -pinia instance. - -*** - -### store - -> **store**: [`Store`](../type-aliases/Store.md)\<`Id`, `S`, `G`, `A`\> - -Current store being extended. diff --git a/packages/docs/api/pinia/interfaces/SetupStoreDefinition.md b/packages/docs/api/pinia/interfaces/SetupStoreDefinition.md deleted file mode 100644 index 494af3fbd3..0000000000 --- a/packages/docs/api/pinia/interfaces/SetupStoreDefinition.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SetupStoreDefinition - -# Interface: SetupStoreDefinition()\ - -Return type of `defineStore()` with a setup function. -- `Id` is a string literal of the store's name -- `SS` is the return type of the setup function - -## See - -[StoreDefinition](StoreDefinition.md) - -## Extends - -- [`StoreDefinition`](StoreDefinition.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> - -## Type Parameters - -• **Id** *extends* `string` - -• **SS** - -> **SetupStoreDefinition**(`pinia`?, `hot`?): [`Store`](../type-aliases/Store.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> - -Return type of `defineStore()` with a setup function. -- `Id` is a string literal of the store's name -- `SS` is the return type of the setup function - -## Parameters - -• **pinia?**: `null` \| [`Pinia`](Pinia.md) - -Pinia instance to retrieve the store - -• **hot?**: [`StoreGeneric`](../type-aliases/StoreGeneric.md) - -dev only hot module replacement - -## Returns - -[`Store`](../type-aliases/Store.md)\<`Id`, [`_ExtractStateFromSetupStore`](../type-aliases/ExtractStateFromSetupStore.md)\<`SS`\>, [`_ExtractGettersFromSetupStore`](../type-aliases/ExtractGettersFromSetupStore.md)\<`SS`\>, [`_ExtractActionsFromSetupStore`](../type-aliases/ExtractActionsFromSetupStore.md)\<`SS`\>\> - -## See - -[StoreDefinition](StoreDefinition.md) - -## Properties - -### $id - -> **$id**: `Id` - -Id of the store. Used by map helpers. - -#### Inherited from - -[`StoreDefinition`](StoreDefinition.md).[`$id`](StoreDefinition.md#$id) diff --git a/packages/docs/api/pinia/interfaces/StoreDefinition.md b/packages/docs/api/pinia/interfaces/StoreDefinition.md deleted file mode 100644 index d58231ac87..0000000000 --- a/packages/docs/api/pinia/interfaces/StoreDefinition.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreDefinition - -# Interface: StoreDefinition()\ - -Return type of `defineStore()`. Function that allows instantiating a store. - -## Extended by - -- [`SetupStoreDefinition`](SetupStoreDefinition.md) - -## Type Parameters - -• **Id** *extends* `string` = `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) = [`StateTree`](../type-aliases/StateTree.md) - -• **G** = [`_GettersTree`](../type-aliases/GettersTree.md)\<`S`\> - -• **A** = [`_ActionsTree`](../type-aliases/ActionsTree.md) - -> **StoreDefinition**(`pinia`?, `hot`?): [`Store`](../type-aliases/Store.md)\<`Id`, `S`, `G`, `A`\> - -Return type of `defineStore()`. Function that allows instantiating a store. - -## Parameters - -• **pinia?**: `null` \| [`Pinia`](Pinia.md) - -Pinia instance to retrieve the store - -• **hot?**: [`StoreGeneric`](../type-aliases/StoreGeneric.md) - -dev only hot module replacement - -## Returns - -[`Store`](../type-aliases/Store.md)\<`Id`, `S`, `G`, `A`\> - -## Properties - -### $id - -> **$id**: `Id` - -Id of the store. Used by map helpers. diff --git a/packages/docs/api/pinia/interfaces/StoreOnActionListenerContext.md b/packages/docs/api/pinia/interfaces/StoreOnActionListenerContext.md deleted file mode 100644 index f8e254775c..0000000000 --- a/packages/docs/api/pinia/interfaces/StoreOnActionListenerContext.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_StoreOnActionListenerContext - -# Interface: \_StoreOnActionListenerContext\ - -Actual type for [StoreOnActionListenerContext](../type-aliases/StoreOnActionListenerContext.md). Exists for refactoring -purposes. For internal use only. -For internal use **only** - -## Type Parameters - -• **Store** - -• **ActionName** *extends* `string` - -• **A** - -## Properties - -### after() - -> **after**: (`callback`) => `void` - -Sets up a hook once the action is finished. It receives the return value -of the action, if it's a Promise, it will be unwrapped. - -#### Parameters - -• **callback**: `A` *extends* `Record`\<`ActionName`, [`_Method`](../type-aliases/Method.md)\> ? (`resolvedReturn`) => `void` : () => `void` - -#### Returns - -`void` - -*** - -### args - -> **args**: `A` *extends* `Record`\<`ActionName`, [`_Method`](../type-aliases/Method.md)\> ? `Parameters`\<`A`\<`A`\>\[`ActionName`\]\> : `unknown`[] - -Parameters passed to the action - -*** - -### name - -> **name**: `ActionName` - -Name of the action - -*** - -### onError() - -> **onError**: (`callback`) => `void` - -Sets up a hook if the action fails. Return `false` to catch the error and -stop it from propagating. - -#### Parameters - -• **callback** - -#### Returns - -`void` - -*** - -### store - -> **store**: `Store` - -Store that is invoking the action diff --git a/packages/docs/api/pinia/interfaces/StoreProperties.md b/packages/docs/api/pinia/interfaces/StoreProperties.md deleted file mode 100644 index 22ca27916e..0000000000 --- a/packages/docs/api/pinia/interfaces/StoreProperties.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreProperties - -# Interface: StoreProperties\ - -Properties of a store. - -## Extended by - -- [`_StoreWithState`](StoreWithState.md) - -## Type Parameters - -• **Id** *extends* `string` - -## Properties - -### \_customProperties - -> **\_customProperties**: `Set`\<`string`\> - -Used by devtools plugin to retrieve properties added with plugins. Removed -in production. Can be used by the user to add property keys of the store -that should be displayed in devtools. - -*** - -### $id - -> **$id**: `Id` - -Unique identifier of the store diff --git a/packages/docs/api/pinia/interfaces/StoreWithState.md b/packages/docs/api/pinia/interfaces/StoreWithState.md deleted file mode 100644 index 3c03565a3d..0000000000 --- a/packages/docs/api/pinia/interfaces/StoreWithState.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_StoreWithState - -# Interface: \_StoreWithState\ - -Base store with state and functions. Should not be used directly. - -## Extends - -- [`StoreProperties`](StoreProperties.md)\<`Id`\> - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](../type-aliases/StateTree.md) - -• **G** - -• **A** - -## Properties - -### \_customProperties - -> **\_customProperties**: `Set`\<`string`\> - -Used by devtools plugin to retrieve properties added with plugins. Removed -in production. Can be used by the user to add property keys of the store -that should be displayed in devtools. - -#### Inherited from - -[`StoreProperties`](StoreProperties.md).[`_customProperties`](StoreProperties.md#_customProperties) - -*** - -### $id - -> **$id**: `Id` - -Unique identifier of the store - -#### Inherited from - -[`StoreProperties`](StoreProperties.md).[`$id`](StoreProperties.md#$id) - -*** - -### $state - -> **$state**: `UnwrapRef`\<`S`\> & [`PiniaCustomStateProperties`](PiniaCustomStateProperties.md)\<`S`\> - -State of the Store. Setting it will internally call `$patch()` to update the state. - -## Methods - -### $dispose() - -> **$dispose**(): `void` - -Stops the associated effect scope of the store and remove it from the store -registry. Plugins can override this method to cleanup any added effects. -e.g. devtools plugin stops displaying disposed stores from devtools. -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 - -`void` - -*** - -### $onAction() - -> **$onAction**(`callback`, `detached`?): () => `void` - -Setups a callback to be called every time an action is about to get -invoked. The callback receives an object with all the relevant information -of the invoked action: -- `store`: the store it is invoked on -- `name`: The name of the action -- `args`: The parameters passed to the action - -On top of these, it receives two functions that allow setting up a callback -once the action finishes or when it fails. - -It also returns a function to remove the callback. Note than when calling -`store.$onAction()` inside of a component, it will be automatically cleaned -up when the component gets unmounted unless `detached` is set to true. - -#### Parameters - -• **callback**: [`StoreOnActionListener`](../type-aliases/StoreOnActionListener.md)\<`Id`, `S`, `G`, `A`\> - -callback called before every action - -• **detached?**: `boolean` - -detach the subscription from the context this is called from - -#### Returns - -`Function` - -function that removes the watcher - -##### Returns - -`void` - -#### Example - -```js -store.$onAction(({ after, onError }) => { - // Here you could share variables between all of the hooks as well as - // setting up watchers and clean them up - after((resolvedValue) => { - // can be used to cleanup side effects -. // `resolvedValue` is the value returned by the action, if it's a -. // Promise, it will be the resolved value instead of the Promise - }) - onError((error) => { - // can be used to pass up errors - }) -}) -``` - -*** - -### $patch() - -#### $patch(partialState) - -> **$patch**(`partialState`): `void` - -Applies a state patch to current state. Allows passing nested values - -##### Parameters - -• **partialState**: [`_DeepPartial`](../type-aliases/DeepPartial.md)\<`UnwrapRef`\<`S`\>\> - -patch to apply to the state - -##### Returns - -`void` - -#### $patch(stateMutator) - -> **$patch**\<`F`\>(`stateMutator`): `void` - -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 - -• **F** *extends* (`state`) => `any` - -##### Parameters - -• **stateMutator**: `ReturnType`\<`F`\> *extends* `Promise`\<`any`\> ? `never` : `F` - -function that mutates `state`, cannot be asynchronous - -##### Returns - -`void` - -*** - -### $reset() - -> **$reset**(): `void` - -Resets the store to its initial state by building a new state object. - -#### Returns - -`void` - -*** - -### $subscribe() - -> **$subscribe**(`callback`, `options`?): () => `void` - -Setups a callback to be called whenever the state changes. It also returns a function to remove the callback. Note -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 - -• **callback**: [`SubscriptionCallback`](../type-aliases/SubscriptionCallback.md)\<`S`\> - -callback passed to the watcher - -• **options?**: `object` & `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 - -`Function` - -function that removes the watcher - -##### Returns - -`void` diff --git a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationBase.md b/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationBase.md deleted file mode 100644 index 8d2754fbf6..0000000000 --- a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationBase.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_SubscriptionCallbackMutationBase - -# Interface: \_SubscriptionCallbackMutationBase - -Base type for the context passed to a subscription callback. Internal type. - -## Extended by - -- [`SubscriptionCallbackMutationDirect`](SubscriptionCallbackMutationDirect.md) -- [`SubscriptionCallbackMutationPatchFunction`](SubscriptionCallbackMutationPatchFunction.md) -- [`SubscriptionCallbackMutationPatchObject`](SubscriptionCallbackMutationPatchObject.md) - -## Properties - -### events? - -> `optional` **events**: `DebuggerEvent` \| `DebuggerEvent`[] - -🔴 DEV ONLY, DO NOT use for production code. Different mutation calls. Comes from -https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in -devtools and plugins **during development only**. - -*** - -### storeId - -> **storeId**: `string` - -`id` of the store doing the mutation. - -*** - -### type - -> **type**: [`MutationType`](../enumerations/MutationType.md) - -Type of the mutation. diff --git a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationDirect.md b/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationDirect.md deleted file mode 100644 index 08a7407362..0000000000 --- a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationDirect.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SubscriptionCallbackMutationDirect - -# Interface: SubscriptionCallbackMutationDirect - -Context passed to a subscription callback when directly mutating the state of -a store with `store.someState = newValue` or `store.$state.someState = -newValue`. - -## Extends - -- [`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md) - -## Properties - -### events - -> **events**: `DebuggerEvent` - -🔴 DEV ONLY, DO NOT use for production code. Different mutation calls. Comes from -https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in -devtools and plugins **during development only**. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`events`](SubscriptionCallbackMutationBase.md#events) - -*** - -### storeId - -> **storeId**: `string` - -`id` of the store doing the mutation. - -#### Inherited from - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`storeId`](SubscriptionCallbackMutationBase.md#storeId) - -*** - -### type - -> **type**: [`direct`](../enumerations/MutationType.md#direct) - -Type of the mutation. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`type`](SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchFunction.md b/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchFunction.md deleted file mode 100644 index f6bacfd586..0000000000 --- a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchFunction.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SubscriptionCallbackMutationPatchFunction - -# Interface: SubscriptionCallbackMutationPatchFunction - -Context passed to a subscription callback when `store.$patch()` is called -with a function. - -## Extends - -- [`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md) - -## Properties - -### events - -> **events**: `DebuggerEvent`[] - -🔴 DEV ONLY, DO NOT use for production code. Different mutation calls. Comes from -https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in -devtools and plugins **during development only**. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`events`](SubscriptionCallbackMutationBase.md#events) - -*** - -### storeId - -> **storeId**: `string` - -`id` of the store doing the mutation. - -#### Inherited from - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`storeId`](SubscriptionCallbackMutationBase.md#storeId) - -*** - -### type - -> **type**: [`patchFunction`](../enumerations/MutationType.md#patchFunction) - -Type of the mutation. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`type`](SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchObject.md b/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchObject.md deleted file mode 100644 index 8a4f417d17..0000000000 --- a/packages/docs/api/pinia/interfaces/SubscriptionCallbackMutationPatchObject.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SubscriptionCallbackMutationPatchObject - -# Interface: SubscriptionCallbackMutationPatchObject\ - -Context passed to a subscription callback when `store.$patch()` is called -with an object. - -## Extends - -- [`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md) - -## Type Parameters - -• **S** - -## Properties - -### events - -> **events**: `DebuggerEvent`[] - -🔴 DEV ONLY, DO NOT use for production code. Different mutation calls. Comes from -https://vuejs.org/guide/extras/reactivity-in-depth.html#reactivity-debugging and allows to track mutations in -devtools and plugins **during development only**. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`events`](SubscriptionCallbackMutationBase.md#events) - -*** - -### payload - -> **payload**: [`_DeepPartial`](../type-aliases/DeepPartial.md)\<`UnwrapRef`\<`S`\>\> - -Object passed to `store.$patch()`. - -*** - -### storeId - -> **storeId**: `string` - -`id` of the store doing the mutation. - -#### Inherited from - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`storeId`](SubscriptionCallbackMutationBase.md#storeId) - -*** - -### type - -> **type**: [`patchObject`](../enumerations/MutationType.md#patchObject) - -Type of the mutation. - -#### Overrides - -[`_SubscriptionCallbackMutationBase`](SubscriptionCallbackMutationBase.md).[`type`](SubscriptionCallbackMutationBase.md#type) diff --git a/packages/docs/api/pinia/type-aliases/ActionsTree.md b/packages/docs/api/pinia/type-aliases/ActionsTree.md deleted file mode 100644 index de30e09152..0000000000 --- a/packages/docs/api/pinia/type-aliases/ActionsTree.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ActionsTree - -# Type Alias: \_ActionsTree - -> **\_ActionsTree**: `Record`\<`string`, [`_Method`](Method.md)\> - -Type of an object of Actions. For internal usage only. -For internal use **only** diff --git a/packages/docs/api/pinia/type-aliases/Awaited.md b/packages/docs/api/pinia/type-aliases/Awaited.md deleted file mode 100644 index e3715f5097..0000000000 --- a/packages/docs/api/pinia/type-aliases/Awaited.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_Awaited - -# Type Alias: \_Awaited\ - -> **\_Awaited**\<`T`\>: `T` *extends* `null` \| `undefined` ? `T` : `T` *extends* `object` & `object` ? `F` *extends* (`value`, ...`args`) => `any` ? [`_Awaited`](Awaited.md)\<`V`\> : `never` : `T` - -## Type Parameters - -• **T** diff --git a/packages/docs/api/pinia/type-aliases/DeepPartial.md b/packages/docs/api/pinia/type-aliases/DeepPartial.md deleted file mode 100644 index bf1119acef..0000000000 --- a/packages/docs/api/pinia/type-aliases/DeepPartial.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_DeepPartial - -# Type Alias: \_DeepPartial\ - -> **\_DeepPartial**\<`T`\>: `{ [K in keyof T]?: _DeepPartial }` - -Recursive `Partial`. Used by [['$patch']](Store.md). - -For internal use **only** - -## Type Parameters - -• **T** diff --git a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md deleted file mode 100644 index bc487d6321..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractActionsFromSetupStore - -# Type Alias: \_ExtractActionsFromSetupStore\ - -> **\_ExtractActionsFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractActionsFromSetupStore_Keys`](ExtractActionsFromSetupStore_Keys.md)\<`SS`\>\> - -For internal use **only** - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore_Keys.md b/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore_Keys.md deleted file mode 100644 index bf41793694..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractActionsFromSetupStore_Keys.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractActionsFromSetupStore\_Keys - -# Type Alias: \_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 - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md deleted file mode 100644 index 2bf518a5cc..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractGettersFromSetupStore - -# Type Alias: \_ExtractGettersFromSetupStore\ - -> **\_ExtractGettersFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractGettersFromSetupStore_Keys`](ExtractGettersFromSetupStore_Keys.md)\<`SS`\>\> - -For internal use **only** - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore_Keys.md b/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore_Keys.md deleted file mode 100644 index dd4b2a8f29..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractGettersFromSetupStore_Keys.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractGettersFromSetupStore\_Keys - -# Type Alias: \_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 - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md b/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md deleted file mode 100644 index 91b59ad8fd..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractStateFromSetupStore - -# Type Alias: \_ExtractStateFromSetupStore\ - -> **\_ExtractStateFromSetupStore**\<`SS`\>: `SS` *extends* `undefined` \| `void` ? `object` : `Pick`\<`SS`, [`_ExtractStateFromSetupStore_Keys`](ExtractStateFromSetupStore_Keys.md)\<`SS`\>\> - -For internal use **only** - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore_Keys.md b/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore_Keys.md deleted file mode 100644 index aa1d7b6b18..0000000000 --- a/packages/docs/api/pinia/type-aliases/ExtractStateFromSetupStore_Keys.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_ExtractStateFromSetupStore\_Keys - -# Type Alias: \_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 - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/GettersTree.md b/packages/docs/api/pinia/type-aliases/GettersTree.md deleted file mode 100644 index 17da56e7a6..0000000000 --- a/packages/docs/api/pinia/type-aliases/GettersTree.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_GettersTree - -# Type Alias: \_GettersTree\ - -> **\_GettersTree**\<`S`\>: `Record`\<`string`, (`state`) => `any` \| () => `any`\> - -Type of an object of Getters that infers the argument. For internal usage only. -For internal use **only** - -## Type Parameters - -• **S** *extends* [`StateTree`](StateTree.md) diff --git a/packages/docs/api/pinia/type-aliases/MapActionsObjectReturn.md b/packages/docs/api/pinia/type-aliases/MapActionsObjectReturn.md deleted file mode 100644 index 7f996ff03e..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapActionsObjectReturn.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapActionsObjectReturn - -# Type Alias: \_MapActionsObjectReturn\ - -> **\_MapActionsObjectReturn**\<`A`, `T`\>: `{ [key in keyof T]: A[T[key]] }` - -For internal use **only** - -## Type Parameters - -• **A** - -• **T** *extends* `Record`\<`string`, keyof `A`\> diff --git a/packages/docs/api/pinia/type-aliases/MapActionsReturn.md b/packages/docs/api/pinia/type-aliases/MapActionsReturn.md deleted file mode 100644 index 48d08dcb60..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapActionsReturn.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapActionsReturn - -# Type Alias: \_MapActionsReturn\ - -> **\_MapActionsReturn**\<`A`\>: `{ [key in keyof A]: A[key] }` - -For internal use **only** - -## Type Parameters - -• **A** diff --git a/packages/docs/api/pinia/type-aliases/MapStateObjectReturn.md b/packages/docs/api/pinia/type-aliases/MapStateObjectReturn.md deleted file mode 100644 index 77157d31e8..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapStateObjectReturn.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapStateObjectReturn - -# Type Alias: \_MapStateObjectReturn\ - -> **\_MapStateObjectReturn**\<`Id`, `S`, `G`, `A`, `T`\>: `{ [key in keyof T]: Function }` - -For internal use **only** - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](StateTree.md) - -• **G** *extends* [`_GettersTree`](GettersTree.md)\<`S`\> \| `object` - -• **A** - -• **T** *extends* `Record`\<`string`, keyof `S` \| keyof `G` \| (`store`) => `any`\> = `object` diff --git a/packages/docs/api/pinia/type-aliases/MapStateReturn.md b/packages/docs/api/pinia/type-aliases/MapStateReturn.md deleted file mode 100644 index 3e28ea0a41..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapStateReturn.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapStateReturn - -# Type Alias: \_MapStateReturn\ - -> **\_MapStateReturn**\<`S`, `G`, `Keys`\>: `{ [key in Keys]: key extends keyof Store ? Function : never }` - -For internal use **only** - -## Type Parameters - -• **S** *extends* [`StateTree`](StateTree.md) - -• **G** *extends* [`_GettersTree`](GettersTree.md)\<`S`\> \| `object` - -• **Keys** *extends* keyof `S` \| keyof `G` = keyof `S` \| keyof `G` diff --git a/packages/docs/api/pinia/type-aliases/MapWritableStateObjectReturn.md b/packages/docs/api/pinia/type-aliases/MapWritableStateObjectReturn.md deleted file mode 100644 index 89e8c2602b..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapWritableStateObjectReturn.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapWritableStateObjectReturn - -# Type Alias: \_MapWritableStateObjectReturn\ - -> **\_MapWritableStateObjectReturn**\<`S`, `T`\>: `{ [key in keyof T]: Object }` - -For internal use **only** - -## Type Parameters - -• **S** *extends* [`StateTree`](StateTree.md) - -• **T** *extends* `Record`\<`string`, keyof `S`\> diff --git a/packages/docs/api/pinia/type-aliases/MapWritableStateReturn.md b/packages/docs/api/pinia/type-aliases/MapWritableStateReturn.md deleted file mode 100644 index e1823e99b9..0000000000 --- a/packages/docs/api/pinia/type-aliases/MapWritableStateReturn.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_MapWritableStateReturn - -# Type Alias: \_MapWritableStateReturn\ - -> **\_MapWritableStateReturn**\<`S`\>: `{ [key in keyof S]: Object }` - -For internal use **only** - -## Type Parameters - -• **S** *extends* [`StateTree`](StateTree.md) diff --git a/packages/docs/api/pinia/type-aliases/Method.md b/packages/docs/api/pinia/type-aliases/Method.md deleted file mode 100644 index e2aec21649..0000000000 --- a/packages/docs/api/pinia/type-aliases/Method.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_Method - -# Type Alias: \_Method() - -> **\_Method**: (...`args`) => `any` - -Generic type for a function that can infer arguments and return type - -For internal use **only** - -## Parameters - -• ...**args**: `any`[] - -## Returns - -`any` diff --git a/packages/docs/api/pinia/type-aliases/PiniaStorePlugin.md b/packages/docs/api/pinia/type-aliases/PiniaStorePlugin.md deleted file mode 100644 index b9bebce994..0000000000 --- a/packages/docs/api/pinia/type-aliases/PiniaStorePlugin.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaStorePlugin - -# Type Alias: ~~PiniaStorePlugin~~ - -> **PiniaStorePlugin**: [`PiniaPlugin`](../interfaces/PiniaPlugin.md) - -Plugin to extend every store. - -## Deprecated - -use PiniaPlugin instead diff --git a/packages/docs/api/pinia/type-aliases/Spread.md b/packages/docs/api/pinia/type-aliases/Spread.md deleted file mode 100644 index edd1eeed99..0000000000 --- a/packages/docs/api/pinia/type-aliases/Spread.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_Spread - -# Type Alias: \_Spread\ - -> **\_Spread**\<`A`\>: `A` *extends* [infer L, `...(infer R)`] ? [`_StoreObject`](StoreObject.md)\<`L`\> & [`_Spread`](Spread.md)\<`R`\> : `unknown` - -For internal use **only**. - -## Type Parameters - -• **A** *extends* readonly `any`[] diff --git a/packages/docs/api/pinia/type-aliases/StateTree.md b/packages/docs/api/pinia/type-aliases/StateTree.md deleted file mode 100644 index d611d84a45..0000000000 --- a/packages/docs/api/pinia/type-aliases/StateTree.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StateTree - -# Type Alias: StateTree - -> **StateTree**: `Record`\<`string` \| `number` \| `symbol`, `any`\> - -Generic state of a Store diff --git a/packages/docs/api/pinia/type-aliases/Store.md b/packages/docs/api/pinia/type-aliases/Store.md deleted file mode 100644 index caaa2c8849..0000000000 --- a/packages/docs/api/pinia/type-aliases/Store.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / Store - -# Type Alias: Store\ - -> **Store**\<`Id`, `S`, `G`, `A`\>: [`_StoreWithState`](../interfaces/StoreWithState.md)\<`Id`, `S`, `G`, `A`\> & `UnwrapRef`\<`S`\> & [`_StoreWithGetters`](StoreWithGetters.md)\<`G`\> & [`_ActionsTree`](ActionsTree.md) *extends* `A` ? `object` : `A` & [`PiniaCustomProperties`](../interfaces/PiniaCustomProperties.md)\<`Id`, `S`, `G`, `A`\> & [`PiniaCustomStateProperties`](../interfaces/PiniaCustomStateProperties.md)\<`S`\> - -Store type to build a store. - -## Type Parameters - -• **Id** *extends* `string` = `string` - -• **S** *extends* [`StateTree`](StateTree.md) = `object` - -• **G** = `object` - -• **A** = `object` diff --git a/packages/docs/api/pinia/type-aliases/StoreActions.md b/packages/docs/api/pinia/type-aliases/StoreActions.md deleted file mode 100644 index bfae843852..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreActions.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreActions - -# Type Alias: StoreActions\ - -> **StoreActions**\<`SS`\>: `SS` *extends* [`Store`](Store.md)\<`string`, [`StateTree`](StateTree.md), [`_GettersTree`](GettersTree.md)\<[`StateTree`](StateTree.md)\>, infer A\> ? `A` : [`_ExtractActionsFromSetupStore`](ExtractActionsFromSetupStore.md)\<`SS`\> - -Extract the actions of a store type. Works with both a Setup Store or an -Options Store. - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/StoreGeneric.md b/packages/docs/api/pinia/type-aliases/StoreGeneric.md deleted file mode 100644 index b43e7d6670..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreGeneric.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreGeneric - -# Type Alias: StoreGeneric - -> **StoreGeneric**: [`Store`](Store.md)\<`string`, [`StateTree`](StateTree.md), [`_GettersTree`](GettersTree.md)\<[`StateTree`](StateTree.md)\>, [`_ActionsTree`](ActionsTree.md)\> - -Generic and type-unsafe version of Store. Doesn't fail on access with -strings, making it much easier to write generic functions that do not care -about the kind of store that is passed. diff --git a/packages/docs/api/pinia/type-aliases/StoreGetters.md b/packages/docs/api/pinia/type-aliases/StoreGetters.md deleted file mode 100644 index 2e47fd7bed..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreGetters.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreGetters - -# Type Alias: StoreGetters\ - -> **StoreGetters**\<`SS`\>: `SS` *extends* [`Store`](Store.md)\<`string`, [`StateTree`](StateTree.md), infer G, [`_ActionsTree`](ActionsTree.md)\> ? [`_StoreWithGetters`](StoreWithGetters.md)\<`G`\> : [`_ExtractGettersFromSetupStore`](ExtractGettersFromSetupStore.md)\<`SS`\> - -Extract the getters of a store type. Works with both a Setup Store or an -Options Store. - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/StoreObject.md b/packages/docs/api/pinia/type-aliases/StoreObject.md deleted file mode 100644 index ac44b65a0e..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreObject.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_StoreObject - -# Type Alias: \_StoreObject\ - -> **\_StoreObject**\<`S`\>: `S` *extends* [`StoreDefinition`](../interfaces/StoreDefinition.md)\ ? \{ \[Id in \`$\{Ids\}$\{MapStoresCustomization extends Record\<"suffix", infer Suffix\> ? Suffix : "Store"\}\`\]: Function \} : `object` - -For internal use **only**. - -## Type Parameters - -• **S** diff --git a/packages/docs/api/pinia/type-aliases/StoreOnActionListener.md b/packages/docs/api/pinia/type-aliases/StoreOnActionListener.md deleted file mode 100644 index b0759c9390..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreOnActionListener.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreOnActionListener - -# Type Alias: StoreOnActionListener()\ - -> **StoreOnActionListener**\<`Id`, `S`, `G`, `A`\>: (`context`) => `void` - -Argument of `store.$onAction()` - -## Type Parameters - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](StateTree.md) - -• **G** - -• **A** - -## Parameters - -• **context**: [`StoreOnActionListenerContext`](StoreOnActionListenerContext.md)\<`Id`, `S`, `G`, `object` *extends* `A` ? [`_ActionsTree`](ActionsTree.md) : `A`\> - -## Returns - -`void` diff --git a/packages/docs/api/pinia/type-aliases/StoreOnActionListenerContext.md b/packages/docs/api/pinia/type-aliases/StoreOnActionListenerContext.md deleted file mode 100644 index ebad81eb8f..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreOnActionListenerContext.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreOnActionListenerContext - -# Type Alias: StoreOnActionListenerContext\ - -> **StoreOnActionListenerContext**\<`Id`, `S`, `G`, `A`\>: [`_ActionsTree`](ActionsTree.md) *extends* `A` ? [`_StoreOnActionListenerContext`](../interfaces/StoreOnActionListenerContext.md)\<[`StoreGeneric`](StoreGeneric.md), `string`, [`_ActionsTree`](ActionsTree.md)\> : `{ [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 - -• **Id** *extends* `string` - -• **S** *extends* [`StateTree`](StateTree.md) - -• **G** - -• **A** diff --git a/packages/docs/api/pinia/type-aliases/StoreState.md b/packages/docs/api/pinia/type-aliases/StoreState.md deleted file mode 100644 index c77a697b43..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreState.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / StoreState - -# Type Alias: StoreState\ - -> **StoreState**\<`SS`\>: `SS` *extends* [`Store`](Store.md)\<`string`, infer S, [`_GettersTree`](GettersTree.md)\<[`StateTree`](StateTree.md)\>, [`_ActionsTree`](ActionsTree.md)\> ? `UnwrapRef`\<`S`\> : [`_ExtractStateFromSetupStore`](ExtractStateFromSetupStore.md)\<`SS`\> - -Extract the state of a store type. Works with both a Setup Store or an -Options Store. Note this unwraps refs. - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/type-aliases/StoreWithActions.md b/packages/docs/api/pinia/type-aliases/StoreWithActions.md deleted file mode 100644 index ea05cb5b93..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreWithActions.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_StoreWithActions - -# Type Alias: \_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 - -• **A** diff --git a/packages/docs/api/pinia/type-aliases/StoreWithGetters.md b/packages/docs/api/pinia/type-aliases/StoreWithGetters.md deleted file mode 100644 index f96e3d5ef1..0000000000 --- a/packages/docs/api/pinia/type-aliases/StoreWithGetters.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_StoreWithGetters - -# Type Alias: \_StoreWithGetters\ - -> **\_StoreWithGetters**\<`G`\>: `_StoreWithGetters_Readonly`\<`G`\> & `_StoreWithGetters_Writable`\<`G`\> - -Store augmented with getters. For internal usage only. -For internal use **only** - -## Type Parameters - -• **G** diff --git a/packages/docs/api/pinia/type-aliases/SubscriptionCallback.md b/packages/docs/api/pinia/type-aliases/SubscriptionCallback.md deleted file mode 100644 index 96dae270b3..0000000000 --- a/packages/docs/api/pinia/type-aliases/SubscriptionCallback.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SubscriptionCallback - -# Type Alias: SubscriptionCallback()\ - -> **SubscriptionCallback**\<`S`\>: (`mutation`, `state`) => `void` - -Callback of a subscription - -## Type Parameters - -• **S** - -## Parameters - -• **mutation**: [`SubscriptionCallbackMutation`](SubscriptionCallbackMutation.md)\<`S`\> - -• **state**: `UnwrapRef`\<`S`\> - -## Returns - -`void` diff --git a/packages/docs/api/pinia/type-aliases/SubscriptionCallbackMutation.md b/packages/docs/api/pinia/type-aliases/SubscriptionCallbackMutation.md deleted file mode 100644 index d7b5c18a46..0000000000 --- a/packages/docs/api/pinia/type-aliases/SubscriptionCallbackMutation.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / SubscriptionCallbackMutation - -# Type Alias: SubscriptionCallbackMutation\ - -> **SubscriptionCallbackMutation**\<`S`\>: [`SubscriptionCallbackMutationDirect`](../interfaces/SubscriptionCallbackMutationDirect.md) \| [`SubscriptionCallbackMutationPatchObject`](../interfaces/SubscriptionCallbackMutationPatchObject.md)\<`S`\> \| [`SubscriptionCallbackMutationPatchFunction`](../interfaces/SubscriptionCallbackMutationPatchFunction.md) - -Context object passed to a subscription callback. - -## Type Parameters - -• **S** diff --git a/packages/docs/api/pinia/type-aliases/UnwrapAll.md b/packages/docs/api/pinia/type-aliases/UnwrapAll.md deleted file mode 100644 index 7aaeae1eb3..0000000000 --- a/packages/docs/api/pinia/type-aliases/UnwrapAll.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / \_UnwrapAll - -# Type Alias: \_UnwrapAll\ - -> **\_UnwrapAll**\<`SS`\>: `{ [K in keyof SS]: UnwrapRef }` - -Type that enables refactoring through IDE. -For internal use **only** - -## Type Parameters - -• **SS** diff --git a/packages/docs/api/pinia/variables/PiniaVuePlugin.md b/packages/docs/api/pinia/variables/PiniaVuePlugin.md deleted file mode 100644 index 976b4ad82a..0000000000 --- a/packages/docs/api/pinia/variables/PiniaVuePlugin.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -editLink: false ---- - -[**API Documentation**](../../index.md) • **Docs** - -*** - -[API Documentation](../../index.md) / [pinia](../index.md) / PiniaVuePlugin - -# Variable: 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 - -```js -import Vue from 'vue' -import { PiniaVuePlugin, createPinia } from 'pinia' - -Vue.use(PiniaVuePlugin) -const pinia = createPinia() - -new Vue({ - el: '#app', - // ... - pinia, -}) -``` - -## Param - -`Vue` imported from 'vue'.