Jsdoc Typescript Docs
CheckedAutomatically generates JSDoc and TypeScript documentation from code comments and function signatures.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add patricio0312rev/skills --skill jsdoc-typescript-docs -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
patricio0312rev
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned patricio0312rev/skills at 79ea6af485.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 79ea6af485
- Scanned
- 1 file, 565 lines
About this skill
The jsdoc-typescript-docs skill enables AI agents to generate and manage JSDoc comments specifically tailored for TypeScript projects. It assists in creating type-safe documentation that aligns with modern JavaScript standards.
When to use it
- Generating inline documentation for new TypeScript functions or classes during code development.
- Updating outdated JSDoc blocks when refactoring existing backend logic.
- Creating comprehensive API reference guides from TypeScript source files.
- Ensuring type definitions are clearly documented for team collaboration.
Key capabilities
- Generates standard JSDoc syntax compatible with TypeScript environments.
- Supports detailed parameter and return type descriptions.
- Facilitates automated documentation extraction for backend services.
Example prompts
- "Generate JSDoc comments for this TypeScript function that calculates tax based on a user's location."
- "Update the existing JSDoc block for the
UserAuthclass to include new security parameters." - "Create a complete API documentation file in JSDoc format from my TypeScript backend module."
Tips & gotchas
Ensure your project is already set up with TypeScript before using this skill, as it relies on type information to generate accurate documentation. For complex projects, provide specific context about the intended audience (e.g., internal developers vs. public API consumers) to tailor the tone and detail level of the generated docs.