jsdoc-strip-async-await

jsdoc plugin to strip async/await keywords before parse.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
jsdoc-strip-async-await
730.1.08 years ago8 years agoMinified + gzip package size for jsdoc-strip-async-await in KB

Readme

jsdoc-strip-async-await
A simple jsdoc plugin that very generically strips async and await keywords from the source file before jsdoc processes it. This allows one to generate documentation for source files that contain async or await.

Installation

$ npm install --save-dev jsdoc-strip-async-await

Usage

Add jsdoc-strip-async-await to your jsdoc config file.
Configuring JSDoc with conf.json
{
  "plugins": ["node_modules/jsdoc-strip-async-await"],
}

Notes

As soon as jsdoc supports async and await natively, this plugin should be removed from your documentation process.