JSPM

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

JSDoc annotations extractor

Package Exports

  • jsdoc-extractor

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

Readme

jsdoc-extractor

version Maintenance MIT dep

JSDoc extractor

Requirements

  • Node.js v10 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i jsdoc-extractor
# or
$ yarn add jsdoc-extractor

Usage example

const jsdocExtractor = require("jsdoc-extractor");
const { readFileSync } = require("fs");

const buf = readFileSync("./sourceCode.js");
for (const doc of jsdocExtractor(buf)) {
    console.log(doc.toString());
    console.log("-------------");
}

License

MIT