Vuex ORM Plugin: Soft Delete

Vuex ORM Soft Delete plugin adds soft delete capabilities to 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.

// 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 💕

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 for any questions and discussions.

Although there is the Slack Channel, do not hesitate to open an issue 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 – The plugin to sync the store against a RESTful API.
• Vuex ORM GraphQL – The plugin to sync the store against a GraphQL API.
• Vuex ORM Search – The plugin adds a search() method to filter records using fuzzy search logic from the Fuse.js.
• Vuex ORM 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.

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.

yarn build

Compile files and generate bundles in dist directory.

yarn lint

Lint files using Prettier.

yarn test

Run the test using Jest.

yarn test:watch

Run the test in watch mode.

yarn coverage

Generate test coverage in coverage directory.

yarn docs

Build and boot documentation server with VuePress.

License

Vuex ORM Plugin: Soft Delete is open-sourced software licensed under the MIT license.