Deleting Data

You can delete data from the store by calling the delete Method on the model class or dispatching the delete action. Both expecting the first argument to be String, Number, Function or Object.

If you use String or Number, a record that matches the condition with its primary key is going to be deleted.

If you use Function, that function is going to be used to determine which record to delete. The function takes the record as the argument and must return boolean.

By passing in an Object as argument the object is expacted to have a where key which have to be String, Number or Function exactly like described above.

Delete Data By Primary Key Value

// Initial state.
let state = {
  entities: {
    users: {
      '1': { id: 1, name: 'John' },
      '2': { id: 1, name: 'Jane' }
    }
  }
}


// Delete single data by primary key value with model class.
User.delete(1);

// Or you can pass obejct as argument as well.
User.delete({ where: 1 })

// Or you can delete data from an existing model instance.
const user = await User.find(1)
user.delete()

// Or you can delete single data by primary key value with vuex action.
store.dispatch('entities/users/delete', 1)

// Or you can pass obejct as argument as well.
store.dispatch('entities/users/delete', { where: 1 })

// State after `delete`
state = {
  entities: {
    users: {
      '2': { id: 1, name: 'Jane' }
    }
  }
}

Delete Data By Closure

// Initial state.
let state = {
  entities: {
    users: {
      '1': { id: 1, name: 'John' },
      '2': { id: 1, name: 'Jane' },
      '3': { id: 1, name: 'George' }
    },
    posts: {
      '1': { id: 1, user_id: 1 },
      '2': { id: 2, user_id: 2 },
      '3': { id: 3, user_id: 3 }
    }
  }
}

// Delete data by closure.
User.delete((record) => {
  return record.id === 1 || record.name === 'Jane'
})

// Or with object style.
User.delete({
  where (record) {
    return record.id === 1 || record.name === 'Jane'
  }
})

// State after `delete`.
state = {
  entities: {
    users: {
      '3': { id: 1, name: 'George' }
    },
    posts: {
      '1': { id: 1, user_id: 1 },
      '2': { id: 2, user_id: 2 },
      '3': { id: 3, user_id: 3 }
    }
  }
}

Delete All Data

You can delete all data in once by deleteAll action.

// Delete all data for an entity
User.deleteAll()

// State after `deleteAll`.
let state = {
  entities: {
    users: {},
    posts: {
      '1': { id: 1, user_id: 1 },
      '2': { id: 2, user_id: 2 },
      '3': { id: 3, user_id: 3 }
    }
  }
}

// Delete all data for all entities
store.dispatch('entities/deleteAll')

// State after `deleteAll`.
state = {
  entities: {
    users: {},
    posts: {}
  }
}

Dispatch Action From Root Module

You can also dispatch action from root module. Remember to pass entity name in this case.

store.dispatch('entities/delete', {
  entity: 'users',
  where: 1
})

Note that since root module needs entity, you can't dispatch root module action by passing condition directly.

// This would not work.
store.dispatch('entities/delete', 1)