# jsdoc-parse

> Transforms jsdoc data into something more suitable for use as template input

Latest version **6.2.5** (published 2025-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install jsdoc-parse
pnpm add jsdoc-parse
yarn add jsdoc-parse
bun add jsdoc-parse
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 6.2.5 |
| Published | 2025-10-03 |
| First published | 2014-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 3 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 106 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | javascript, jsdoc, parse, document, documentation |

## Links

- npm: https://www.npmjs.com/package/jsdoc-parse
- Repository: https://github.com/jsdoc2md/jsdoc-parse
- Homepage: https://github.com/jsdoc2md/jsdoc-parse#readme
- Issues: https://github.com/jsdoc2md/jsdoc-parse/issues
- npm.io page: https://npm.io/package/jsdoc-parse

## Dependencies (3)

- [array-back](https://npm.io/package/array-back.md) ^6.2.2
- [sort-array](https://npm.io/package/sort-array.md) ^5.0.0
- [find-replace](https://npm.io/package/find-replace.md) ^5.0.1

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 6.2.5 (latest) — 2025-10-03
- 6.2.4 — 2024-09-01
- 6.2.3 — 2024-08-30
- 6.2.2 — 2024-08-29
- 6.2.1 — 2024-01-31
- 6.2.0 — 2022-11-28
- 6.1.0 — 2022-01-29
- 6.0.1 — 2021-06-29
- 6.0.0 — 2021-02-26
- 5.0.0 — 2020-05-31
- 4.0.1 — 2019-08-30
- 4.0.0 — 2019-08-30
- 3.0.1 — 2018-01-09
- 3.0.0 — 2017-02-09
- 2.0.5 — 2016-10-04
- … 48 more at https://npm.io/package/jsdoc-parse/versions

## README

[![view on npm](https://badgen.net/npm/v/jsdoc-parse)](https://www.npmjs.org/package/jsdoc-parse)
[![npm module downloads](https://badgen.net/npm/dt/jsdoc-parse)](https://www.npmjs.org/package/jsdoc-parse)
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-parse)](https://github.com/jsdoc2md/jsdoc-parse/network/dependents?dependent_type=REPOSITORY)
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-parse)](https://github.com/jsdoc2md/jsdoc-parse/network/dependents?dependent_type=PACKAGE)
[![Node.js CI](https://github.com/jsdoc2md/jsdoc-parse/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-parse/actions/workflows/node.js.yml)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# jsdoc-parse

Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:

* Support for new tags in the input javascript
  * `@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`).

## Command-line usage

This module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown/), you can see the output using this command:

```
$ jsdoc2md --json <files>
```

* * *

&copy; 2014-24 Lloyd Brookes \<75pound@gmail.com\>.

Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

---
_Source: https://npm.io/package/jsdoc-parse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._