API Reference¶
The Image Editor API documentation is generated using TypeDoc and provides comprehensive documentation for all public interfaces, functions, and components.
Generating API Documentation¶
To generate the API documentation locally:
This will generate documentation in the api-docs/ directory.
Viewing Documentation¶
After generating, you can serve the documentation locally:
API Overview¶
The Image Editor exposes the following main modules:
Components¶
React components for the image editor interface.
Utils¶
Utility functions for image manipulation and processing:
- Image Processing: Functions for manipulating image data
- Canvas Operations: Helpers for canvas-based rendering
- File Handling: Utilities for loading and saving images
Types¶
TypeScript interfaces and types used throughout the application.
Development¶
For detailed implementation information, generate the full API documentation using npm run docs.