1.1.0 • Published 5 years ago
@yurderi/vue-models v1.1.0
vue-models
A better way to use entities in vue.js
Requirements
- axios
- vue
Installation
yarn add @yurderi/vue-modelsBasic usage
import Vue from 'vue'
import VueModels from '@yurderi/vue-models'
import axios from 'axios'
Vue.use(VueModels, {
models: require.context(__dirname + '/models/'),
http: axios.create()
})
// ... later
Vue.models.user.list().then(users => {
console.log(users)
})
// ... or
Vue.component('v-test', {
data: () => ({
items: []
}),
mounted() {
this.$models.user.list().then(users => this.items = users)
}
})API Documentation
| Method | Description |
|---|---|
public create () : Object | Creates an empty model containing default values |
public save (data: Array) : Promise<Object> | Creates/saves a model entity |
public get (id: Integer) : Promise<Object> | Gets a model by id |
public remove (model: Object) : Promise<Boolean> | Removes a model by object (identified by id) |
public list (params: Object) : Promise<Array> | List all models with additional params |
public filter (models: Object, search: String) : Array | Filter a set of models by search phrase |
private __normalizeRow (data: Object) : Object | Applies types to model fields |