maya-dates

@drewsonne/maya-dates / Exports / FullDate

Class: FullDate

Minimal interface used for equality comparison across calendar components.

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new FullDate(cr, lc)

Create a new full date.

Parameters

Name Type Description
cr CalendarRound Calendar Round component.
lc LongCount Long Count component.

Overrides

CommentWrapper.constructor

Defined in

full-date.ts:21

Properties

comment

comment: Comment

Attached comment.

Inherited from

CommentWrapper.comment

Defined in

comment-wrapper.ts:11


cr

cr: CalendarRound

Defined in

full-date.ts:12


lc

lc: LongCount

Defined in

full-date.ts:13

Methods

appendComment

appendComment(comment): any

Append additional text to the current comment.

Parameters

Name Type
comment string | Comment

Returns

any

Inherited from

CommentWrapper.appendComment

Defined in

comment-wrapper.ts:34


commentIsEqual

commentIsEqual(otherCommentWrapper): boolean

Compare this wrapper’s comment against another wrapper.

Parameters

Name Type
otherCommentWrapper CommentWrapper

Returns

boolean

Inherited from

CommentWrapper.commentIsEqual

Defined in

comment-wrapper.ts:52


equal

equal(other): boolean

Compare two full dates for equality.

Parameters

Name Type
other IPart

Returns

boolean

Implementation of

IPart.equal

Defined in

full-date.ts:45


equalWithComment

equalWithComment(otherCommentWrapper): boolean

Check equality including the associated comment.

Parameters

Name Type
otherCommentWrapper IPart

Returns

boolean

Inherited from

CommentWrapper.equalWithComment

Defined in

comment-wrapper.ts:59


isPartial

isPartial(): boolean

Determine if either component contains wildcards.

Returns

boolean

Defined in

full-date.ts:38


setComment

setComment(comment): any

Replace the current comment.

Parameters

Name Type
comment string | Comment

Returns

any

Inherited from

CommentWrapper.setComment

Defined in

comment-wrapper.ts:20


toString

toString(): string

Render the full date as a string containing both components.

Returns

string

Defined in

full-date.ts:31