@drewsonne/maya-dates / Exports / HaabMonth
Describes only the month component of a Haab fullDate
↳ HaabMonth
• new HaabMonth(raw
)
Name | Type | Description |
---|---|---|
raw |
string | Wildcard |
Name of the Haab month |
• Protected
cycleLength: number
• Protected
generator: (cycleName
: string
| number
) => Wildcard
| Cycle
▸ (cycleName
): Wildcard
| Cycle
Name | Type |
---|---|
cycleName |
string | number |
• position: number
Absolute position within the linear cycle for this object.
• Protected
value: any
▸ isWildcard(): boolean
boolean
▸ next(): Cycle
Return the next object in the cycle
▸ shift(incremental
): Cycle
Move an incremental number of steps in the cycle, and return the object found there.
Name | Type | Description |
---|---|---|
incremental |
number |
The number of steps to move through in the cycle. |
▸ toString(): string
Render this cycle object as a string
string
▸ validate(): boolean
Ensure a Haab month name is defined, and that the month name is within the set of allowable values.
boolean