Reference

Information-oriented technical documentation

References provide comprehensive technical details, API documentation, and specifications. This is your go-to resource when you need precise information whilst working with Typeflows.

What You’ll Find Here

  • API Documentation: Complete method and class references
  • Configuration Options: All available settings and parameters
  • Technical Specifications: Detailed format descriptions and requirements
  • Quick Reference: Concise lookup tables and cheat sheets

Who Should Use This Section

  • Experienced developers working with Typeflows
  • Anyone implementing specific functionality
  • Developers debugging or troubleshooting
  • Teams needing authoritative technical details

How to Use References

Reference material is designed for lookup, not sequential reading:

  • Comprehensive Coverage: Every feature and option documented
  • Precise Information: Exact syntax, parameters, and behaviour
  • Minimal Explanation: Focus on facts, not concepts
  • Easy Navigation: Organised for quick access to specific information

Use references when you know what you’re looking for but need the exact details of how it works.