API

The complete API documentation for @drewsonne/maya-dates is generated from TypeScript source code using TypeDoc.

📚 View Complete API Reference →

The full API reference is organized by type and includes detailed documentation for:

• Classes: Core classes for Maya calendar date manipulation
• Interfaces: TypeScript interfaces for type safety
• Functions: Utility functions and factory methods
• Enumerations: Enum types for calendar components
• Type Definitions: Complete type information for all exports

Key Classes

Some of the most important classes you'll work with:

• LongCount - Represents a Maya Long Count date
• CalendarRound - Represents a Calendar Round date
• FullDate - Combines Calendar Round and Long Count
• LongCountFactory - Factory for parsing Long Count dates
• CalendarRoundFactory - Factory for parsing Calendar Round dates

Need Help?

• Check the Usage Guide for common patterns
• Read the Domain Model to understand Maya calendar systems
• Browse the Design Patterns for implementation details