Skip to content
This repository was archived by the owner on Oct 28, 2021. It is now read-only.

Feverqwe/mst-jsdoc-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mst-jsdoc-gen

Simple jsdoc generator for mobx-state-tree

Example

In model.js write:

import { types, onSnapshot } from "mobx-state-tree"

const Todo = types
    .model("Todo", {
        title: types.string,
        done: false
    })
    .actions(self => ({
        toggle() {
            self.done = !self.done
        }
    }))

const Store = types.model("Store", {
    todos: types.array(Todo)
})

After run npm start and see result:

/**
* @typedef {{}} Todo
* @property {string} title
* @property {boolean} done
* @property {function} toggle
*/


/**
* @typedef {{}} Store
* @property {Todo[]} todos
*/

About

Simple jsdoc generator for mobx-state-tree

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •