vuex-orm/plugin-decorator

Vuex ORM decorator for model field definitions.

Vuex ORM Decorator

Vuex ORM Decorator is the TypeScript decorator for defining Vuex ORM fields.

Sponsors

Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community 💕

Super Love Sponsors

A Love Sponsors

Documentation

Coming soon...

Questions & Discussions

Join us on our Slack Channel for any questions and discussions.

Although there is the Slack Channel, do not hesitate to open an issue for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.

Quick Start

Coming soon...

Plugins

Vuex ORM can be extended via a plugin to add additional features. Here is the list of available plugins.

• Vuex ORM Axios – The plugin to sync the store against a RESTful API.
• Vuex ORM GraphQL – The plugin to sync the store against a GraphQL API.
• Vuex ORM Search – The plugin adds a search() method to filter records using fuzzy search logic from the Fuse.js.
• Vuex ORM Change Flags - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
• Vuex ORM Soft Delete – Vuex ORM plugin for adding soft delete feature to model entities.

Contribution

We are excited that you are interested in contributing to Vuex ORM Decorator! Anything from raising an issue, submitting an idea of a new feature, or making a pull request is welcome!

Development

$ yarn build

Compile files and generate bundles in dist directory.

$ yarn lint

Lint files using a rule of Standard JS.

$ yarn test

Run the test using Jest.

$ yarn test:watch

Run the test in watch mode.

$ yarn coverage

Generate test coverage in coverage directory.

License

The Vuex ORM Decorator is open-sourced software licensed under the MIT license.

plugin-decorator's Issues

Missing documentation

This plugin is still missing most of its documentation.

Can somebody please explain how to use it?