Gathering detailed insights and metrics for @microsoft/tsdoc
Gathering detailed insights and metrics for @microsoft/tsdoc
Installations
npm install @microsoft/tsdocDeveloper 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
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
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,850 Stars
1,148 Commits
140 Forks
47 Watchers
30 Branches
10,000 Contributors
Updated on Jul 05, 2025
Bundle Size
130.10 kB
Minified
22.63 kB
Minified + Gzipped
Maintainers
2
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
@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:
No vulnerabilities found.
Reason
11 commit(s) out of 30 and 1 issue activity out of 30 found in the last 90 days -- score normalized to 10
Reason
no vulnerabilities detected
Reason
no dangerous workflow patterns detected
Reason
tokens are read-only in GitHub workflows
Reason
license file detected
Details
- Info: : LICENSE:1
Reason
all dependencies are pinned
Details
- Info: GitHub-owned GitHubActions are pinned
- Info: Third-party GitHubActions are pinned
- Info: Dockerfile dependencies are pinned
- Info: no insecure (not pinned by hash) dependency downloads found in Dockerfiles
- Info: no insecure (not pinned by hash) dependency downloads found in shell scripts
Reason
no binaries found in the repo
Reason
security policy file detected
Details
- Info: security policy detected in org repo: github.com/microsoft/.github/SECURITY.md:1
Reason
branch protection is not maximal on development and all release branches
Details
- Info: 'force pushes' disabled on branch 'main'
- Info: 'allow deletion' disabled on branch 'main'
- Info: status check found to merge onto on branch 'main'
- Warn: number of required reviewers is only 1 on branch 'main'
Reason
GitHub code reviews found for 22 commits out of the last 30 -- score normalized to 7
Details
- Warn: no reviews found for commit: d8ce4aedcf64b5c948e7152ba02ac6c7bdedc9be
- Warn: no reviews found for commit: 33065d9b0b8bcf0ea084d94da208e9c85e02d890
- Warn: no reviews found for commit: 8d56b9e75c2c85d247de1e881dddb95ada9d8345
- Warn: no reviews found for commit: 72a0833c3b34e7bac8896a20e3ff3c83b329599c
Reason
no badge detected
Reason
no update tool detected
Details
- Warn: dependabot config file not detected in source location. We recommend setting this configuration in code so it can be easily verified by others.
- Warn: renovatebot config file not detected in source location. We recommend setting this configuration in code so it can be easily verified by others.
Reason
project is not fuzzed
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