typescript-jsdoc
Document TypeScript APIs with JSDoc
TypeScript teams often write comments that repeat types or miss important behavior. This skill guides focused JSDoc for APIs, examples, errors, and maintenance notes.
Install with my Agent
Copy this request to your Agent. It includes the canonical Skill page and manifest.
Review the Skillstore skill "typescript-jsdoc" from https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc.md and its manifest at https://skillstore.io/api/skills/adammanuel-dev-typescript-jsdoc/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Your Agent should still show its plan and request any confirmation required by the security policy.
Agent-readable resources
Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.
Test it
Using "typescript-jsdoc". A public authentication service method with login errors and retry behavior.
Expected outcome:
The result explains the service purpose, expected credentials, possible authentication and network errors, and a short usage example.
Using "typescript-jsdoc". A generic helper that removes duplicate items from an array.
Expected outcome:
The result documents the type parameter, uniqueness rule, optional identifier function, and returned array behavior.
Using "typescript-jsdoc". A simple formatter with comments that repeat TypeScript types.
Expected outcome:
The result recommends removing redundant parameter descriptions and keeping only useful display intent or examples.
Security Audit
SafeAll static findings are false positives caused by Markdown code fences, inline TypeScript identifiers, and static documentation examples. I found no prompt injection, malicious intent, command execution, network access, secret access, or reconnaissance behavior in SKILL.md or patterns.md.
Risk Factors
⚙️ External commands (26)
🌐 Network access (1)
Share & cite this report
Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.
Copy report link
https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdown badge
[](https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc?utm_source=security_passport_badge)HTML badge
<a href="https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/adammanuel-dev-typescript-jsdoc/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Embed card
<iframe src="https://skillstore.io/embed/skills/adammanuel-dev-typescript-jsdoc.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Academic citations (APA · BibTeX · CFF)
APA citation
AdamManuel-dev. (2026). typescript-jsdoc security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8BibTeX citation
@techreport{adammanuel-dev-adammanuel-dev-typescript-jsdoc-2026,
author = {AdamManuel-dev},
title = {typescript-jsdoc security audit report (audit version 8)},
institution = {Skillstore},
year = {2026},
number = {8},
url = {https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "typescript-jsdoc security audit report (audit version 8)"
version: "unspecified"
type: report
authors:
- name: "AdamManuel-dev"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/adammanuel-dev-typescript-jsdoc/audits/8"
identifiers:
- type: other
value: "skillstore:adammanuel-dev-typescript-jsdoc:audit:8"
description: "Skillstore immutable audit report identifier"
Skillstore Score
Why this score Evidence Confidence: HighWhat You Can Build
Document Public Library APIs
Create clear JSDoc for exported functions, classes, and interfaces before release.
Clarify Complex Application Code
Add comments that explain retries, caching, errors, side effects, and usage constraints.
Review Comment Quality
Remove redundant comments and keep documentation focused on behavior and intent.
Try These Prompts
Add concise JSDoc to this TypeScript function. Focus on purpose, parameters, return value, and any important edge case.
Review this exported TypeScript API and write JSDoc that explains behavior, errors, and one practical usage example.
Audit these JSDoc comments for redundancy. Keep only information that explains intent, constraints, side effects, or usage.
Create a TypeScript JSDoc standard for this codebase. Include required tags, optional tags, anti-patterns, and review criteria.
Best Practices
- Document public APIs, exported modules, complex behavior, errors, and stable usage contracts.
- Use JSDoc to explain why code behaves a certain way, not only what the types show.
- Keep examples current when behavior, side effects, performance, or error conditions change.
Avoid
- Do not repeat TypeScript type information without adding useful context.
- Do not document unstable implementation details that may change during refactoring.
- Do not add long comments to obvious helpers when names and types already explain behavior.
Frequently Asked Questions
Does this skill generate JSDoc for TypeScript code?
Does it support generic functions?
Can it document React components?
Will it run commands or access external services?
How does it avoid redundant comments?
Is it suitable for private codebases?
Developer Details
Author
AdamManuel-devLicense
MIT
Skillstore revision
r1
Version notice
The author did not declare a version.
Ref
c1fdca50ff516318f65fed0d7f9e82797c5171dc
Maintenance freshness
7/18/2026
Usage
7 downloads · 253 views
File structure
📄 SKILL.md