From: Eduardo San Martin Morote Date: Fri, 7 Apr 2023 12:43:52 +0000 (+0200) Subject: docs: regen api X-Git-Tag: @pinia/nuxt@0.4.8~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1da03e8be24d660ec570604eed70136e8b2c5693;p=thirdparty%2Fvuejs%2Fpinia.git docs: regen api --- diff --git a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md index 973578bc..9232b6ce 100644 --- a/packages/docs/api/interfaces/pinia_testing.TestingOptions.md +++ b/packages/docs/api/interfaces/pinia_testing.TestingOptions.md @@ -50,7 +50,7 @@ ___ • `Optional` **fakeApp**: `boolean` Creates an empty App and calls `app.use(pinia)` with the created testing -pinia. This is allows you to use plugins while unit testing stores as +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. @@ -78,7 +78,7 @@ ___ • `Optional` **stubActions**: `boolean` -When set to false, actions are only spied, they still get executed. When +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 diff --git a/packages/docs/api/modules/pinia.md b/packages/docs/api/modules/pinia.md index 31123e34..272fb44d 100644 --- a/packages/docs/api/modules/pinia.md +++ b/packages/docs/api/modules/pinia.md @@ -1040,7 +1040,7 @@ added. [`_MapWritableStateObjectReturn`](pinia.md#_mapwritablestateobjectreturn)<`S`, `KeyMapper`\> -▸ **mapWritableState**<`Id`, `S`, `G`, `A`\>(`useStore`, `keys`): [`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> +▸ **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 @@ -1054,17 +1054,18 @@ of a component. | `S` | extends [`StateTree`](pinia.md#statetree) | | `G` | extends [`_GettersTree`](pinia.md#_getterstree)<`S`\> | | `A` | `A` | +| `Keys` | extends `string` \| `number` \| `symbol` | #### Parameters %{#Functions-mapWritableState-Parameters_1}% | Name | Type | Description | | :------ | :------ | :------ | | `useStore` | [`StoreDefinition`](../interfaces/pinia.StoreDefinition.md)<`Id`, `S`, `G`, `A`\> | store to map from | -| `keys` | keyof `S`[] | array of state properties | +| `keys` | readonly `Keys`[] | array of state properties | #### Returns %{#Functions-mapWritableState-Returns_1}% -[`_MapWritableStateReturn`](pinia.md#_mapwritablestatereturn)<`S`\> +{ [K in Keys]: Object } ___