# esdoc-node

> Allows esdoc to use node.js exports and module.exports.

Latest version **1.0.5** (published 2019-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install esdoc-node
pnpm add esdoc-node
yarn add esdoc-node
bun add esdoc-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2019-09-30 |
| First published | 2016-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Jeremie Pelletier |
| Maintainers | jeremiep |
| Keywords | esdoc, node |

## Links

- npm: https://www.npmjs.com/package/esdoc-node
- Repository: https://github.com/ddude/esdoc-node
- Homepage: https://github.com/ddude/esdoc-node#readme
- Issues: https://github.com/ddude/esdoc-node/issues
- npm.io page: https://npm.io/package/esdoc-node

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2019-09-30
- 1.0.4 — 2018-12-04
- 1.0.3 — 2018-01-29
- 1.0.2 — 2017-04-25
- 1.0.1 — 2017-02-27
- 1.0.0 — 2016-06-16

## README

# esdoc-node

[![](https://travis-ci.org/lcodes/esdoc-node.svg)](https://travis-ci.org/lcodes/esdoc-node)

## Usage

Get the package:

``` shell
npm install esdoc-node
```

Add the following to your esdoc config file:

``` json
{
  "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:

| Before                                    | After                            |
|-------------------------------------------|----------------------------------|
|`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 '...';`                   |

---
_Source: https://npm.io/package/esdoc-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._