jsdoc-parse
Advanced tools
Readme
Transforms jsdoc data into something more suitable for use as template input. Also adds a few tags to the default set:
@category <string>: Useful for grouping identifiers by category.@done: Used to mark @todo items as complete.@typicalname: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are $ (the typical name for jQuery instances), _ (underscore) etc.@chainable: Set to mark a method as chainable (has a return value of this).This module is built into jsdoc-to-markdown, you can see the output using this command:
$ jsdoc2md --json <files>
© 2014-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.
FAQs
Transforms jsdoc data into something more suitable for use as template input
The npm package jsdoc-parse receives a total of 109,099 weekly downloads. As such, jsdoc-parse popularity was classified as popular.
We found that jsdoc-parse demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The White House is addressing fragmented cybersecurity regulations as CISOs report spending up to 50% of their time on compliance, aiming to harmonize requirements and improve cybersecurity outcomes.
Security News
Research
The Socket Research Team has identified a malicious Python package that is typosquatting the popular crytic-compile utility, frequently used in popular toolkits and development environments for smart contracts and crypto applications.
Security News
NIST updates on the NVD backlog after media reports that over 50% of KEVs were unenriched since mid-February. They've contracted additional support and partnered with CISA to clear the backlog by fiscal year-end.