docblock-reader

johnwatkins0
js
docblock-reader JS library on npm Download docblock-reader JS library

A docblock parser.

Version 1.0.0-dev License ISC
docblock-reader has no homepage
docblock-reader JS library on GitHub
docblock-reader JS library on npm
Download docblock-reader JS library
INSTALL
Type:
Version:
<script type="module"> import docblockReader from 'https://cdn.jsdelivr.net/npm/docblock-reader@1.0.0-dev/+esm' </script>
Learn more
Readme Files Statistics Browse CDN

docblock-reader

A docblock parser. Currently in development, starting with support for docblocks formatted based on JSDoc and WordPress standards.

Install

npm install docblock-reader

OR

yarn add docblock-reader

Usage example

import getDocblocks from 'docblock-reader';

getDocblocks({
  files:['./src/index.js', './src/someOtherFile.js'],
  context: 'javascript',
  callback: console.log
});

Parameters

Name Type Description Required/Default
files array/string An array of files or a glob (e.g. ./src/**/*.js) required
context string The language context for which the docblocks should be parsed. Supports 'wordpress' and 'javascript'. default 'javascript'
callback function A callback for handling the parsed docblocks. required