API Reference
Detailed API documentation is generated from source code.
Rust API
Full Rust API documentation with examples:
Generated with cargo doc. Includes:
- All public types and functions
- Module documentation
- Code examples
- Type signatures
Generate Locally
cargo xtask docs --target rust --open
Node.js API
TypeScript definitions with JSDoc comments:
Generated with TypeDoc. Includes:
- All exported functions and classes
- Type definitions
- Parameter descriptions
Generate Locally
cargo xtask docs --target node --open
Python API
Python type stubs with docstrings:
Generated with pdoc. Includes:
- All classes and functions
- Type hints
- Docstrings
Generate Locally
cargo xtask docs --target python --open
Quick Reference
Core Types
| Type | Rust | Node.js | Python |
|---|---|---|---|
| Converter | Converter | Converter | Converter |
| Pool | ConverterPool | ConverterPool | ConverterPool |
| Result | PdfResult | PdfResult | PdfResult |
| Options | PdfOptions | PdfOptions | PdfOptions |
Functions by Feature
| Feature | Functions |
|---|---|
| Conversion | html_to_pdf, url_to_pdf |
| Watermarks | add_watermark, add_watermarks |
| Bookmarks | add_bookmarks, extract_bookmarks |
| Annotations | add_annotations, list_annotations, remove_annotations |
| Encryption | encrypt_pdf, decrypt_pdf |
| Signing | sign_pdf, sign_pdf_visible, verify_signatures |
| Forms | add_form_fields, validate_form_fields |
| PDF/A | validate_pdfa, add_pdfa_metadata |
| PDF/UA | validate_pdfua, add_pdfua_metadata |