Optimistic Mutations

[Akryum]

Clear and concise description of the problem

rstore stats only updates after mutations are fully resolved. UI feeling of responsiveness can be improved by optimistically updating the cache with a reasonable expected result from the actual mutation.

Suggested solution

Create

store.Todo.create({
  text: 'Learn Vue.js'
}, {
  optimistic: {
    id: crypto.randomUUID(),
    createdDate: new Date(),
  },
})

store.Todo.createForm({
  optimistic: () => ({
    id: crypto.randomUUID(),
    createdDate: new Date(),
  }),
})

Update

store.Todo.update({
  completed: true, // Auto optimistic update
}, {
  key: 'some-id',
  optimistic: {
    updatedDate: new Date(),
  },
})

store.Todo.updateForm('some-id', {
  optimistic: () => ({
    updatedDate: new Date(),
  }),
})

Model config

const todoModel = {
  name: 'Todo',
  optimistic: {
    create: (item) => ({
      id: crypto.randomUUID(),
      createdDate: new Date(),
    }),
    update: (item) => ({
      updatedDate: new Date(),
    }),
  },
}

Check if item is optimistic (on create):

newTodo.$isOptimistic()

Check which properties are optimistically updated on an item:

editedTodo.$optimisticUpdates()
// => { updatedDate: Date }

Alternative

No response

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that requests the same feature to avoid creating a duplicate.