# jsdoc-ignore-future

> JSDoc plugin allowing one to exempt from parsing code that may be supported by a transpiler but not JSDoc's parser.

Latest version **1.1.0** (published 2016-04-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install jsdoc-ignore-future
pnpm add jsdoc-ignore-future
yarn add jsdoc-ignore-future
bun add jsdoc-ignore-future
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-04-05 |
| First published | 2016-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Chris Nordhougen |
| Maintainers | cwnord |
| Keywords | jsdoc |

## Links

- npm: https://www.npmjs.com/package/jsdoc-ignore-future
- Repository: https://github.com/cnordhougen/jsdoc-ignore-future
- Homepage: https://github.com/cnordhougen/jsdoc-ignore-future#readme
- Issues: https://github.com/cnordhougen/jsdoc-ignore-future/issues
- npm.io page: https://npm.io/package/jsdoc-ignore-future

## Recent versions

- 1.1.0 (latest) — 2016-04-05
- 1.0.0 — 2016-03-31

## README

# jsdoc-ignore-future
JSDoc plugin allowing one to exempt from parsing code that may be supported by a transpiler but not JSDoc's parser.

# Install
`npm install --save-dev jsdoc-ignore-future`

# Usage
Add `"node_modules/jsdoc-ignore-future"` to the plugins array in your jsdoc config.
Put comments above & below code you wish for the JSDoc parser to ignore as in the following example:
```javascript
//es-future>
@Decorator('foo')
//<es-future
class MyClass {
    //es-future>
    myProp = 'something';
    static myStatic = [];
    //<es-future
    
    constructor( bar ) {
        this.bar = bar;
    }
}
```

# Configuration
You can configure what the starting and closing comments are in your jsdoc conf.json.
```json
{
    "plugins": [ "node_modules/jsdoc-ignore-future" ],
    "ignoreFuture": {
        "start": "myStartComment",
        "end":   "myEndComment"
    }
}
```

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