https://github.com/vuex-orm/plugin-decorator
Vuex ORM decorator for model field definitions.
https://github.com/vuex-orm/plugin-decorator
vue vuex vuex-orm vuex-orm-plugin vuex-plugin
Last synced: 7 days ago
JSON representation
Vuex ORM decorator for model field definitions.
- Host: GitHub
- URL: https://github.com/vuex-orm/plugin-decorator
- Owner: vuex-orm
- License: mit
- Created: 2019-11-19T11:52:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T01:12:33.000Z (over 2 years ago)
- Last Synced: 2025-04-03T20:21:53.466Z (about 2 months ago)
- Topics: vue, vuex, vuex-orm, vuex-orm-plugin, vuex-plugin
- Language: TypeScript
- Size: 1.09 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
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 :two_hearts:
### Super Love Sponsors
#### A Love Sponsors
## Documentation
Coming soon...
## Questions & Discussions
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.
Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/vuex-orm/issues) 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](https://github.com/vuex-orm/plugin-axios) – The plugin to sync the store against a RESTful API.
- [Vuex ORM GraphQL](https://github.com/vuex-orm/plugin-graphql) – The plugin to sync the store against a [GraphQL](https://graphql.org) API.
- [Vuex ORM Search](https://github.com/vuex-orm/plugin-search) – The plugin adds a search() method to filter records using fuzzy search logic from the [Fuse.js](http://fusejs.io).
- [Vuex ORM Change Flags](https://github.com/vuex-orm/plugin-change-flags) - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
- [Vuex ORM Soft Delete](https://github.com/vuex-orm/plugin-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
```bash
$ yarn build
```
Compile files and generate bundles in `dist` directory.
```bash
$ yarn lint
```
Lint files using a rule of Standard JS.
```bash
$ yarn test
```
Run the test using [Jest](https://jestjs.io/).
```bash
$ yarn test:watch
```
Run the test in watch mode.
```bash
$ yarn coverage
```
Generate test coverage in `coverage` directory.
## License
The Vuex ORM Decorator is open-sourced software licensed under the [MIT license](LICENSE.md).