maya-dates

@drewsonne/maya-dates / Exports

@drewsonne/maya-dates

Table of contents

Enumerations

Classes

Interfaces

Variables

Functions

Variables

lords

Const lords: _LordsOfTheNight

Defined in

lc/night/lord-of-night.ts:94

Functions

coefficientParser

coefficientParser(rawCoefficient): ICoefficient

Parameters

Name Type
rawCoefficient string | number | Wildcard

Returns

ICoefficient

Defined in

cr/component/coefficient.ts:9


getCalendarRound

getCalendarRound(tzolkin, haab): CalendarRound

Return a comparable instance of a Calendar Round.

Parameters

Name Type
tzolkin Tzolkin
haab Haab

Returns

CalendarRound

Defined in

cr/calendar-round.ts:18


getCorrelationConstant

getCorrelationConstant(id): CorrelationConstant

Return a Lord of the Night by its G id.

Parameters

Name Type
id string

Returns

CorrelationConstant

Defined in

lc/correlation-constant.ts:48

getCorrelationConstant(id): CorrelationConstant

Parameters

Name Type
id number

Returns

CorrelationConstant

Defined in

lc/correlation-constant.ts:49


getHaab

getHaab(coeff, month): Haab

Return a comparable HaabMonth instantiation.

Parameters

Name Type
coeff ICoefficient
month Wildcard | HaabMonth

Returns

Haab

Defined in

cr/haab.ts:18


getHaabMonth

getHaabMonth(newCycleName): HaabMonth | Wildcard

Parameters

Name Type
newCycleName string | number | Wildcard

Returns

HaabMonth | Wildcard

Defined in

cr/component/haabMonth.ts:52


getTzolkin

getTzolkin(coeff, day): Tzolkin

Return a comparable instance of a Tzolkin date.

Parameters

Name Type
coeff ICoefficient
day Wildcard | TzolkinDay

Returns

Tzolkin

Defined in

cr/tzolkin.ts:18


getTzolkinDay

getTzolkinDay(name): TzolkinDay | Wildcard

Parameters

Name Type
name string | number | Wildcard

Returns

TzolkinDay | Wildcard

Defined in

cr/component/tzolkinDay.ts:54


isComment

isComment(c): c is Comment

Type guard to check if a value is a Comment instance.

Parameters

Name Type
c any

Returns

c is Comment

Defined in

comment.ts:49


isNumberPrimitive

isNumberPrimitive(x): x is number

Determine if a value is a number primitive.

Parameters

Name Type Description
x any Value to test.

Returns

x is number

Defined in

guards.ts:6


isPart

isPart(o): o is IPart

Type guard to ensure a value implements IPart.

Parameters

Name Type Description
o any Value to test.

Returns

o is IPart

True if o implements IPart.

Defined in

i-part.ts:18


isStringPrimitive

isStringPrimitive(x): x is string

Determine if a value is a string primitive.

Parameters

Name Type Description
x any Value to test.

Returns

x is string

Defined in

guards.ts:15


isWildcard

isWildcard(token): token is Wildcard

Parameters

Name Type
token any

Returns

token is Wildcard

Defined in

wildcard.ts:31


wrapsComment

wrapsComment(o): o is CommentWrapper

Type guard for CommentWrapper.

Parameters

Name Type
o any

Returns

o is CommentWrapper

Defined in

comment-wrapper.ts:78