@enterthenamehere/esdoc-accessor-plugin

A accessor plugin for ESDoc

Usage no npm install needed!

<script type="module">
  import enterthenamehereEsdocAccessorPlugin from 'https://cdn.skypack.dev/@enterthenamehere/esdoc-accessor-plugin';
</script>

README

ESDoc Accessor Plugin

Use with updated EnterTheNameHere/esdoc-monorepo. Original esdoc is here.

Install

npm install @enterthenamehere/esdoc-accessor-plugin

Config

{
    "source": "./src",
    "destination": "./doc",
    "plugins": [
        {
            "name": "@enterthenamehere/esdoc-accessor-plugin",
            "option": {
                "access": [
                    "public",
                    "protected",
                    "private"],
                "autoPrivate": true
            }
        }
    ]
}
  • access is default ["public", "protected", "private"]
  • autoPrivate is default true

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru