JSPM

jsdoc-export-default-interop

0.3.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3879
  • Score
    100M100P100Q204374F
  • License MIT

jsdoc-export-default-interop

Package Exports

  • jsdoc-export-default-interop

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jsdoc-export-default-interop) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

jsdoc-export-default-interop

npm Dependency Status

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