vuese-vuex
Plugin for vuese to allow it to work with vuex store files
Last updated 4 months ago by tayhobbs .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vuese-vuex 
SYNC missed versions from official npm registry.

vuese-vuex

Friendly addon to @vuese to allow it to work with a Vuex store file.

This code was originally a PR to @vuese, but it was determined that Vuex Store was out of scope for @vuese. This addon will gladly be merged with @vuese if the maintainers wish.

Installation

npm i vuese-vuex -D

#Usage

Vuese-vuex must be run after vuese has already generated the index.html file for the documentation website. It updates the sidebar with the link to the store.js doc file.

vuese gen && vuese-vuex gen

Getters, Actions, and Mutations follow the same rules for methods in a component. (Must be marked with a @vuese comment).

Example

//store.js

export default {
    getters: {
        // @vuese
        // Getter used for testing
        testGetter() {

        }
    },
    actions: {
        // @vuese
        // The number one action for the project
        // @arg The first
        // @arg The second
        myNumberOneAction(arg1, arg2) {

        }
    },
    mutations: {
        // @vuese
        // My only mutation
        // @arg The value to set
        CHANGE_THE_STATE(value) {
        }
    },
    state: {
        // @vuese
        // used for determining if someone can use perms
        permissions: {}
    }
}

Current Tags

  • 1.1.0                                ...           latest (4 months ago)

2 Versions

  • 1.1.0                                ...           4 months ago
  • 1.0.1                                ...           7 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |