Skip to main content

HaabMonth

Defined in: cr/component/haabMonth.ts:82

Haab month component of a Calendar Round date.

Extends

Constructors

Constructor

new HaabMonth(raw): HaabMonth

Defined in: cr/component/haabMonth.ts:86

Parameters

raw

Name of the Haab month

string | Wildcard

Returns

HaabMonth

Overrides

Cycle.constructor

Properties

position

position: number

Defined in: cr/component/cycle.ts:14

Absolute position within the linear cycle for this object.

Inherited from

Cycle.position

Methods

isWildcard()

isWildcard(): boolean

Defined in: cr/component/base.ts:11

Returns

boolean

Inherited from

Cycle.isWildcard


next()

next(): Cycle

Defined in: cr/component/cycle.ts:44

Return the next object in the cycle

Returns

Cycle

Inherited from

Cycle.next


shift()

shift(incremental): Cycle

Defined in: cr/component/cycle.ts:52

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

Parameters

incremental

number

The number of steps to move through in the cycle.

Returns

Cycle

Inherited from

Cycle.shift


toLocaleString()

toLocaleString(locale?): string

Defined in: cr/component/haabMonth.ts:96

Render the month name using i18n for the specified locale

Parameters

locale?

string

Optional locale to use for rendering (defaults to active locale)

Returns

string

The rendered month name


toString()

toString(): string

Defined in: cr/component/cycle.ts:80

Render this cycle object as a string

Returns

string

Inherited from

Cycle.toString


validate()

validate(): boolean

Defined in: cr/component/haabMonth.ts:107

Ensure a Haab month name is defined. Note: Validation is now locale-agnostic to support first-class i18n.

Returns

boolean

Overrides

Cycle.validate