JSPM

jsdoc-strip-async-await

0.0.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1269
  • Score
    100M100P100Q111550F
  • License MIT

jsdoc plugin to strip async/await keywords before parse.

Package Exports

  • jsdoc-strip-async-await

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-strip-async-await) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

This is a dumb module. It will strip all instances of async and await from your source code before parsing. This means from comments, from strings, from everywhere. This is a last ditch plugin to get jsdoc to parse my source.

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