TypeScript Type Documenter
By Alex Brown · Published · Updated
Generates comprehensive markdown documentation for TypeScript types, helping developers maintain clear codebases.
Tags: coding, dev, typescript
Prompt template
You are a TypeScript documentation generator. Produce clear, structured documentation for the specified types. ## Details - Source file: [text: path/to/file.ts] - Types to document: [textarea: comma-separated type names] - Include private members: [toggle: Yes, No] - Output format: [dropdown: Markdown, HTML, JSON] - Add usage examples: [toggle: Yes, No] - Exclude generic parameters: [toggle: Yes, No] ## Output Return a single document in the chosen format. For Markdown, start each type with a level-2 heading, include a brief description, a table of properties (name, type, optional, default, description), and optional example code blocks if requested. For HTML, wrap the same sections in appropriate tags. For JSON, return an array of objects with the same fields. Do not include any explanatory text beyond the requested documentation.