@netsells/vuex-crud-mutations

Easily scaffold Vuex CRUD mutations

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
10Jun 11, 2021Jul 27, 2018Minified + gzip package size for @netsells/vuex-crud-mutations in KB

Readme

Vuex Crud Mutations

Quickly scaffold CRUD mutations in Vuex

npm npm Travis branch Codecov branch
Commitizen friendly styled with prettier

Why?

Quite often, your vuex mutations contain basic methods to manipulate your set of data. If your app has multiple data sets you end up repeating the same methods multiple times for different entities.

This module generates all that scaffold/boilerplate for you and keeps the crud "verbs" consistent (set, add, update, delete).

Installation

yarn add @netsells/vuex-crud-mutations

Usage

In your Vue store add the results of the exported function to your mutations object. We're using the ES6 spread operator here (...) but you can use any object merging strategy you like.

The following examples will be using user as our "entity".

// Pull the plugin in
import crudMutations from '@netsells/vuex-crud-mutations';

// Set up your store
module.exports = new Vuex.Store({
    state: {
        members: [], // Make sure you define your initial data
        products: [],
    },
    mutations: {
        ...crudMutations('user'), // Generate entity mutations - ensure the entity is singular
        ...crudMutations('product'), // You can generate multiple entities
    },
});

This will generate mutations for setting, creating, updating and deleting items in the entity. You can commit these mutations using the following commands within your Vue components.

// Set your entity data
// This will replace the entire dataset
this.$store.commit('setMembers', [
    // ...data
]);

// Add an item to your entity data
this.$store.commit('addMember', {
    // ...data
});

// Update an item in your entity data
// The merging strategy here is based on the `id` property provided in the data object
this.$store.commit('updateMember', {
    // ...data
});

// Delete an item in your entity data
this.$store.commit('deleteMember', id);

FAQ

Can I use this in namespaced Vuex modules?

Yes, simply modify your mutations to include the module namespace e.g. this.$store.commit('users/addUser', { ... });

Contributors


Sam Turrell

💻 📖 💡 ⚠️

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT © Netsells Ltd.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.