Installations

npm install @microsoft/tsdoc

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.20.5

NPM Version

10.8.2 Score

99.9

Supply Chain

88.8

Quality

79

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

8

Total

210

Closed

14

Merged

188

Issues

Open

135

Total

196

Closed

61

Releases

42

Languages

6

TypeScript

JavaScript

CSS

Shell

Handlebars

SCSS

TypeScript (97.39%)

JavaScript (1.94%)

CSS (0.28%)

Shell (0.21%)

Handlebars (0.14%)

SCSS (0.03%)

Developer

microsoft

Download Statistics

Total Downloads

275,620,993

Last Day

212,444

Last Week

4,509,603

Last Month

19,588,719

Last Year

169,952,388

GitHub Statistics

MIT License

4,849 Stars

1,148 Commits

139 Forks

47 Watchers

30 Branches

10,000 Contributors

Updated on Jul 01, 2025

Bundle Size

130.10 kB

Minified

22.63 kB

Minified + Gzipped

Bundlephobia

Maintainers

2

View All 10,000 Contributors

Package Meta Information

Latest Version

0.15.1

Package Id

@microsoft/tsdoc@0.15.1

Unpacked Size

2.59 MB

Size

354.27 kB

File Count

443

NPM Version

10.8.2

Node Version

18.20.5

Published on

Nov 23, 2024

Total Downloads

Cumulative downloads

Total Downloads

275,620,993

Last Day

-8.8%

212,444

Compared to previous day

Last Week

-7.1%

4,509,603

Compared to previous week

Last Month

5.2%

19,588,719

Compared to previous month

Last Year

187.2%

169,952,388

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

5

@rushstack/heft-web-rig @rushstack/heft @types/heft-jest eslint eslint-plugin-header

@microsoft/tsdoc

This library is the reference implementation of a parser for the TSDoc syntax. Using this library is an easy way to ensure that your tool is 100% compatible with the standard.

What is TSDoc?

TSDoc is a proposal to standardize the doc comments used in TypeScript source files. It allows different tools to extract content from comments without getting confused by each other's syntax. The TSDoc notation looks pretty familiar:

1export class Statistics {
2  /**
3   * Returns the average of two numbers.
4   *
5   * @remarks

6   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
7   *
8   * @param x - The first input number
9   * @param y - The second input number
10   * @returns The arithmetic mean of `x` and `y`
11   *
12   * @beta

13   */
14  public static getAverage(x: number, y: number): number {
15    return (x + y) / 2.0;
16  }
17}

Give it a try!

Check out the TSDoc Playground for a cool live demo of our parser!

API Usage

The api-demo folder on GitHub illustrates how to invoke the TSDoc parser.

A separate NPM package @microsoft/tsdoc-config is used for loading the tsdoc.json file.

Get involved

The TSDoc project is actively evolving. Please visit the website for the latest documentation, instructions for building/debugging the projects, and other resources:

https://tsdoc.org/

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

License

Determines if the project has defined a license.

10

Pinned-Dependencies

Determines if the project has declared and pinned its dependencies.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Security-Policy

Determines if the project has published a security policy.

8

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

7

Code-Review

Determines if the project requires code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has a CII Best Practices Badge.

0

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.7

/10

Last Scanned on 2022-08-15

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @microsoft/tsdoc

Other packages similar to @microsoft/tsdoc

@microsoft/tsdoc

Installations

Developer Guide

No

CommonJS

18.20.5

10.8.2

Score

Pull Requests

8

210

14

188

Issues

135

196

61

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

130.10 kB

22.63 kB

Maintainers

Package Meta Information

Total Downloads

275,620,993

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@microsoft/tsdoc

What is TSDoc?

Give it a try!

API Usage

Get involved

10

10

10

10

10

10

10

10

8

7

0

0

0

7.7

/10