diagram
Generate diagrams in various formats
Generate diagrams in Mermaid, PlantUML, or other formats.
Import
import { diagram } from 'ai-functions'Syntax
diagram`description`
diagram`description`(options)
diagram(description: string, options?: DiagramOptions)Examples
// Tagged template
const flow = await diagram`user authentication flow`
const erd = await diagram`e-commerce database schema`
const arch = await diagram`microservices architecture`
// With options
const architecture = await diagram('system architecture', {
format: 'mermaid',
type: 'flowchart',
services: ['auth', 'users', 'orders', 'payments'],
})Diagram Types
// Flowcharts
const flow = await diagram`checkout process flow`
// Sequence diagrams
const seq = await diagram`API request sequence for ${endpoint}`
// Entity-relationship
const erd = await diagram`database schema for ${domain}`
// Architecture
const arch = await diagram`system architecture with ${components}`
// State machines
const state = await diagram`order state machine`Options
| Option | Type | Description |
|---|---|---|
format | 'mermaid' | 'plantuml' | 'd2' | Output format |
type | string | Diagram type |
style | string | Visual style |
Output
Returns diagram code as string:
const diagram = await diagram`authentication flow`
// ```mermaid
// flowchart TD
// A[Login Page] --> B{Valid Credentials?}
// B -->|Yes| C[Dashboard]
// B -->|No| D[Error Message]
// ```Was this page helpful?