Installation and Usage

@rattus-orm/vuex is a separate package that does not include the core library. To start using ORM with Vuex in your Vue application, you need to install everything:

yarn add @rattus-orm/core @rattus-orm/vuex vuex@next

Basic Usage Example

The simplest way to set up Rattus ORM with Vuex is to use the built-in Vuex plugin:

import { createApp } from 'vue'
import { createStore } from 'vuex'
import { installRattusORM } from "@rattus-orm/vuex";

const store = createStore({ 
  plugins: [installRattusORM()]
})


const app = createApp({ /* your root component */ })
app.use(store)

<template>
  <p>{{ user.email }}</p>
  <button type="button" @click="onClick">Update email</button>
</template>

<script lang="ts">
import { defineComponent } from 'vue'
import { Model } from '@rattus-orm/core'
import { UidField, StringField } from '@rattus-orm/core/field-types'
import { useRepositoryComputed } from '@rattus-orm/vuex'

class User extends Model {
public static entity = 'user'

@UidField()
public id: string

@StringField()
public email: string
}

export default defineComponent({
  setup() {
    const { save, find } = useRepositoryComputed(User)
    
    save({ id: '1', email: 'test@test.com' })
    
    const onClick = () => {
      save({ id: '1', email: 'updated@test.com' })
    }
    
    const user = find('1')
    
    return {
      user,
      onClick,
    }
  }
})
</script>

Using plugins

If you want to use plugins with a database, you can pass an array of plugins into the plugin configuration object. For example, a validation plugin with Zod:

const store = createStore({ 
  plugins: [
    installRattusORM({
      plugins: [RattusZodValidationPlugin()]
    })
  ]
})