https://github.com/vuex-orm/plugin-soft-delete
Vuex ORM plugin for adding soft delete feature to model entities.
https://github.com/vuex-orm/plugin-soft-delete
vue vuex vuex-orm vuex-orm-plugin vuex-plugin
Last synced: 6 days ago
JSON representation
Vuex ORM plugin for adding soft delete feature to model entities.
- Host: GitHub
- URL: https://github.com/vuex-orm/plugin-soft-delete
- Owner: vuex-orm
- License: mit
- Created: 2018-03-21T04:26:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-12T06:45:30.000Z (over 2 years ago)
- Last Synced: 2025-04-21T14:35:58.078Z (about 1 month ago)
- Topics: vue, vuex, vuex-orm, vuex-orm-plugin, vuex-plugin
- Language: TypeScript
- Homepage: https://vuex-orm.github.io/plugin-soft-delete/
- Size: 2.52 MB
- Stars: 16
- Watchers: 1
- Forks: 3
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Vuex ORM Plugin: Soft Delete
Vuex ORM Soft Delete plugin adds soft delete capabilities to [Vuex ORM](https://github.com/vuex-orm/vuex-orm) models.
The plugin allows models to be soft deleted or "trashed" without actually removing them from the entity data set. Subsequently, when executing queries, the soft deleted models will be excluded from results. Using query modifiers, queries can be instructed to inclusively or exclusively retrieve soft deletes.
```js
// Model action example...
User.softDelete(1)
// Instance action example...
const user = User.find(1)
await user.$softDelete()
// Query integration example...
User.query().withTrashed().get()
User.query().onlyTrashed().get()
```
Sponsors
Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:
Super Love Sponsors
Big Love Sponsors
A Love Sponsors
## Documentation
You can check out the full documentation for Vuex ORM Plugin: Soft Delete at https://vuex-orm.github.io/plugin-soft-delete.
## Questions & Discussions
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.
Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/plugin-soft-delete/issues) for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.
## Plugins
Vuex ORM can be extended via plugins to add additional features. Here is a list of available plugins.
- [Vuex ORM Axios](https://github.com/vuex-orm/plugin-axios) – The plugin to sync the store against a RESTful API.
- [Vuex ORM GraphQL](https://github.com/vuex-orm/plugin-graphql) – The plugin to sync the store against a [GraphQL](https://graphql.org) API.
- [Vuex ORM Search](https://github.com/vuex-orm/plugin-search) – The plugin adds a search() method to filter records using fuzzy search logic from the [Fuse.js](http://fusejs.io).
- [Vuex ORM Change Flags](https://github.com/vuex-orm/plugin-change-flags) - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
Also, you can find a list of awesome things related to Vuex ORM at [Awesome Vuex ORM](https://github.com/vuex-orm/awesome-vuex-orm).
## Contribution
We are excited that you are interested in contributing to Vuex ORM Plugin: Soft Delete! Anything from raising an issue, submitting an idea of a new feature, or making a pull request is welcome! Before submitting your contribution though, please make sure to take a moment and read through the following guidelines.
### Pull Request Guidelines
When submitting a new pull request, please make sure to follow these guidelines:
- **For feature requests:** Checkout a topic branch from `dev` branch, and merge back against `dev` branch.
- **For bug fixes:** Checkout a topic branch from `master` branch, and merge back against `master` branch.
These rules also apply to the documentation. If you're submitting documentation about a new feature that isn't released yet, you must checkout the `dev` branch, but for non-functional updates, such as fixing a typo, you may checkout and commit to the `master` branch.
### Scripts
There are several scripts to help with development.
```bash
yarn build
```
Compile files and generate bundles in `dist` directory.
```bash
yarn lint
```
Lint files using [Prettier](https://prettier.io/).
```bash
yarn test
```
Run the test using [Jest](https://jestjs.io/).
```bash
yarn test:watch
```
Run the test in watch mode.
```bash
yarn coverage
```
Generate test coverage in `coverage` directory.
```bash
yarn docs
```
Build and boot documentation server with [VuePress](https://vuepress.vuejs.org/).
## License
Vuex ORM Plugin: Soft Delete is open-sourced software licensed under the [MIT license](./LICENSE).