]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
docs: regen api
authorEduardo San Martin Morote <posva13@gmail.com>
Fri, 7 Apr 2023 12:43:52 +0000 (14:43 +0200)
committerEduardo San Martin Morote <posva13@gmail.com>
Fri, 7 Apr 2023 12:43:52 +0000 (14:43 +0200)
packages/docs/api/interfaces/pinia_testing.TestingOptions.md
packages/docs/api/modules/pinia.md

index 973578bc82d7e08aaf11a24ac1f09cf04b29f9fb..9232b6cee609eec917d5ac6249c3a4db18eccb4f 100644 (file)
@@ -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
index 31123e342c59950c0ed41d2b44b91d4b655706e7..272fb44dd32bbcf2bda4b74c2a95a5535810eed4 100644 (file)
@@ -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 }
 
 ___