refactor: create-cli

Author: logustra

create/templates/module/services/exampleService.ts

@@ -6,16 +6,17 @@ export default class ExampleService {
   /**
    * @param  {Http} http
    */
-  public constructor(http: Http) {
+  public constructor (http: Http) {
     this.http = http
   }
 
   /**
    * @param  {string} url
    * @param  {{}} params?
    * @param  {{}} config?
+   * @returns Promise
    */
-  public async get(url: string, params?: {}, config?: {}) {
+  public async get (url: string, params?: {}, config?: {}): Promise<any> {
     try {
       return await this.http.get(url, params, config)
     } catch (error) {

create/templates/module/stores/exampleActions.ts

@@ -3,6 +3,9 @@ import { API_EXAMPLE } from '../../constants'
 import { exampleService } from '../../services'
 
 const actions: {[key: string]: Function} = {
+  /**
+   * @param  {{commit:Function}} {commit}
+   */
   [types.EXAMPLE_REQUEST]: async ({ commit }: { commit: Function }) => {
     commit(types.EXAMPLE_REQUEST)
 

create/templates/module/stores/exampleGetters.ts

@@ -1,6 +1,9 @@
 import { ExampleState } from '../../typings/exampleTypings'
 
 const getters: {[key: string]: Function} = {
+  /**
+   * @param  {ExampleState} state
+   */
   example: (state: ExampleState) => state
 }
 

create/templates/module/stores/exampleMutations.ts

@@ -1,20 +1,31 @@
 import * as types from './exampleTypes'
-import { 
+import {
   ExampleState,
   ExampleDataModel
 } from '../../typings/exampleTypings'
 
 const mutations: {[key: string]: Function} = {
+  /**
+   * @param  {ExampleState} state
+   */
   [types.EXAMPLE_REQUEST]: (state: ExampleState) => {
     state.isFetching = true
     state.isError = false
   },
 
+  /**
+   * @param  {ExampleState} state
+   * @param  {ExampleDataModel[]} response
+   */
   [types.EXAMPLE_SUCCESS]: (state: ExampleState, response: ExampleDataModel[]) => {
     state.data = response
     state.isFetching = false
   },
 
+  /**
+   * @param  {ExampleState} state
+   * @param  {boolean} response
+   */
   [types.EXAMPLE_ERROR]: (state: ExampleState, response: boolean) => {
     state.isFetching = false
     state.isError = response