Skip to content

ExampleData

Represents the parsed result of @example tags in JSDoc.

Signature

typescript
interface ExampleData {
  title?: string;
  code: string;
  language?: string;
}

Properties

  • title · string

    Optional title of the example

  • codeRequired · string

    Example code content

  • language · string

    Programming language for syntax highlighting

Released under the MIT License.