maya-dates

@drewsonne/maya-dates / Exports / HaabMonth

Class: HaabMonth

Describes only the month component of a Haab fullDate

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new HaabMonth(raw)

Parameters

Name Type Description
raw string | Wildcard Name of the Haab month

Overrides

Cycle.constructor

Defined in

cr/component/haabMonth.ts:76

Properties

cycleLength

Protected cycleLength: number

Inherited from

Cycle.cycleLength

Defined in

cr/component/cycle.ts:16


generator

Protected generator: (cycleName: string | number) => Wildcard | Cycle

Type declaration

▸ (cycleName): Wildcard | Cycle

Parameters
Name Type
cycleName string | number
Returns

Wildcard | Cycle

Inherited from

Cycle.generator

Defined in

cr/component/cycle.ts:15


position

position: number

Absolute position within the linear cycle for this object.

Inherited from

Cycle.position

Defined in

cr/component/cycle.ts:14


value

Protected value: any

Inherited from

Cycle.value

Defined in

cr/component/base.ts:5

Methods

isWildcard

isWildcard(): boolean

Returns

boolean

Inherited from

Cycle.isWildcard

Defined in

cr/component/base.ts:11


next

next(): Cycle

Return the next object in the cycle

Returns

Cycle

Inherited from

Cycle.next

Defined in

cr/component/cycle.ts:42


shift

shift(incremental): Cycle

Move an incremental number of steps in the cycle, and return the object found there.

Parameters

Name Type Description
incremental number The number of steps to move through in the cycle.

Returns

Cycle

Inherited from

Cycle.shift

Defined in

cr/component/cycle.ts:50


toString

toString(): string

Render this cycle object as a string

Returns

string

Inherited from

Cycle.toString

Defined in

cr/component/cycle.ts:78


validate

validate(): boolean

Ensure a Haab month name is defined, and that the month name is within the set of allowable values.

Returns

boolean

Overrides

Cycle.validate

Defined in

cr/component/haabMonth.ts:85