jsdoc-export-default-interop v0.3.1

jsdoc-export-default-interop

What is this?

A jsdoc plugin for changing exports behaviour so es6 default exports that are not interopable with commonjs module requires are properly documented

Installation

Install via NPM.

$ npm install jsdoc-export-default-interop --save-dev

Add plugin to jsdoc conf.json.

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc|x)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": ["../node_modules/jsdoc-export-default-interop/dist/index"],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    }
}

API Reference

jsdoc-export-default-interop

A jsdoc plugin for changing exports behaviour so es6 default exports that are not interopable with commonjs module requires are properly documented

jsdoc-export-default-interop ⏏ exports.astNodeVisitor : Object

The plugin object.

Kind: exports constant of jsdoc-export-default-interop See: http://usejsdoc.org/about-plugins.html