Skip to content

Commit f001530

Browse files
committed
add Badge deprecated to keepCopiesInStore
1 parent 71a47dc commit f001530

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/3.0-major-release.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,14 @@ This behavior exactly matches the new `useFind` utility.
6565

6666
## Deprecations
6767

68-
### The `keepCopiesInStore` Option
68+
### The `keepCopiesInStore` Option<Badge text="deprecated" type="warning"/>
6969

7070
The `keepCopiesInStore` option is now deprecated. This was a part of the "clone and commit" API which basically disabled the reason for creating the "clone and commit" API in the first place.
7171

7272
If you're not familiar with the Feathers-Vuex "clone and commit" API, you can learn more about the [built-in data modeling](./model-classes.md) API and the section about [Working with Forms](./feathers-vuex-forms.md#the-clone-and-commit-pattern).
7373

7474
The `keepCopiesInStore` feature is set to be removed in Feathers-Vuex 4.0.
7575

76-
### Auth Plugin State: `user`
76+
### Auth Plugin State: `user`<Badge text="deprecated" type="warning"/>
7777

7878
As described, earlier on this page, since the Auth Plugin's `user` state is no longer reactive and has been replaced by a `user` getter that IS reactive, the `user` state will be removed in the Feathers-Vuex 4.0.

docs/common-patterns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ todoCopy.commit()
482482
todoCopy2.commit()
483483
```
484484

485-
You can use the `keepCopiesInStore` option to make this service keep all of its copies in `state.copiesById`. Remember that to comply with Vuex `strict` mode (if that's a concern for you), you'll have to write custom mutations. If it's not a concern (maybe you're the sole developer or whatever reason), you could technically turn off `strict` mode, enable `keepCopiesInStore`, and modify them however you desire, ignoring custom mutations.
485+
You can use the `keepCopiesInStore`<Badge text="deprecated" type="warning"/> option to make this service keep all of its copies in `state.copiesById`. Remember that to comply with Vuex `strict` mode (if that's a concern for you), you'll have to write custom mutations. If it's not a concern (maybe you're the sole developer or whatever reason), you could technically turn off `strict` mode, enable `keepCopiesInStore`, and modify them however you desire, ignoring custom mutations.
486486

487487
```js
488488
import Vue from 'vue'

docs/model-classes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ console.log(todoCopy.description) // --> 'Do something else!'
360360

361361
There's another use case for using `.clone()`. Vuex has a `strict` mode that's really useful in development. It throws errors if any changes occur in the Vuex store `state` outside of mutations. Clone really comes in handy here, because you can make changes to the clone without having to write custom Vuex mutations. When you're finished making changes, call `.commit()` to update the store. This gives you `strict` mode compliance with little effort!
362362

363-
> Nonte: You could previously use the `keepCopiesInStore` option to keep copies in `state.copiesById`. In 2.0, this feature is deprecated and will be removed from the next release.
363+
> Note: You could previously use the `keepCopiesInStore`<Badge text="deprecated" type="warning"/> option to keep copies in `state.copiesById`. In 2.0, this feature is deprecated and will be removed from the next release.
364364
365365
### `instance.commit()`
366366

0 commit comments

Comments
 (0)