@drewsonne/maya-dates / Exports / TzolkinDay
Describes only the day component of a 260-day cycle
↳ TzolkinDay
• new TzolkinDay(newName)
| Name | Type | Description |
|---|---|---|
newName |
string | number | Wildcard |
Name or position of the 260-day cycle day |
• 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 the Tzolk’in day name is defined and is within the list of acceptable day names.
boolean