1.0.5 • Published 5 years ago

esdoc-node v1.0.5

Weekly downloads
3,396
License
MIT
Repository
github
Last release
5 years ago

esdoc-node

npm.io

Usage

Get the package:

npm install esdoc-node

Add the following to your esdoc config file:

{
  "plugins": [{"name": "esdoc-node"}]
}

What it does

It converts the input of esdoc so that node.js' exports and module.exports becomes ES6's export, and require becomes import.

This table shows the translation rules:

BeforeAfter
module.exports = ...;export default ...;
exports.Hello = class Hello { ... };export class Hello { ... };
exports.world = function world() { ... };export function world() { ... };
exports.value = value;export { value };
exports.value = ...;export let value = ...;
const value = require(...)import value from '...';
const { one, two } = require(...)import { one, two} from '...';
const { one: two } = require(...)import { one as two} from '...';
const { one: { two } } = require(...)import * as random from '...';
const { one: { two } } = random;
require(...)import '...';