The Complete Production SOP: How to Deploy and Run TypeDoc TypeScript API Documentation in Autonomous AI Agents

---
name: "typedoc-typescript-api-extractor"
description: "Extract comprehensive HTML and Markdown API documentation from TypeScript codebases."
metadata:
  author: "TypeDoc"
  version: "1.0.0"
  runtime_compatibility:
    - "codex"
    - "claude-code"
    - "cursor"
    - "windsurf"
triggers:
  - "generate typescript docs typedoc"
  - "use typedoc-plugin-markdown"
  - "document typescript interfaces"
permissions:
  fs_read: true
  fs_write: "workspace"
  shell_exec: true
  net_access: false
---

# TypeDoc TypeScript API Documentation SOP
1. Configure settings in typedoc.json with entryPoints: ["src/index.ts"].
2. Document public APIs with TSDoc tags (@param, @returns, @remarks, @typeParam).
3. Generate markdown files using `typedoc --plugin typedoc-plugin-markdown`.
4. Set excludePrivate: true and excludeInternal: true to omit internal implementation details.

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["src/index.ts"],
  "out": "docs/api",
  "plugin": ["typedoc-plugin-markdown"],
  "readme": "none",
  "excludePrivate": true,
  "excludeInternal": true,
  "excludeProtected": false,
  "githubPages": false,
  "hideGenerator": true
}

/**
 * Core orchestrator for background job scheduling.
 * @remarks
 * Implements exponential backoff with jitter.
 */
export interface JobScheduler<T = Record<string, unknown>> {
  /**
   * Dispatches a job with specific payload parameters.
   * @param id - Unique identifier for task deduplication.
   * @param payload - Payload containing job inputs.
   * @returns A promise resolving to the execution transaction ID.
   */
  dispatch(id: string, payload: T): Promise<string>;
}

#!/usr/bin/env bash
set -euo pipefail

if [ ! -d "docs/api" ] || [ -z "$(ls -A docs/api)" ]; then
  echo "Error: API documentation directory docs/api is empty." >&2
  exit 1
fi

echo "API documentation successfully generated and validated."