Skip to main content

FullDate

Defined in: full-date.ts:10

Minimal interface used for equality comparison across calendar components.

Extends​

Implements​

Constructors​

Constructor​

new FullDate(cr, lc): FullDate

Defined in: full-date.ts:21

Create a new full date.

Parameters​

cr​

CalendarRound

Calendar Round component.

lc​

LongCount

Long Count component.

Returns​

FullDate

Overrides​

CommentWrapper.constructor

Properties​

comment​

comment: Comment

Defined in: comment-wrapper.ts:11

Attached comment.

Inherited from​

CommentWrapper.comment


cr​

cr: CalendarRound

Defined in: full-date.ts:12


lc​

lc: LongCount

Defined in: full-date.ts:13

Methods​

appendComment()​

appendComment(comment): this

Defined in: comment-wrapper.ts:42

Append additional text to the current comment.

Parameters​

comment​

string | Comment

Returns​

this

Inherited from​

CommentWrapper.appendComment


commentIsEqual()​

commentIsEqual(otherCommentWrapper): boolean

Defined in: comment-wrapper.ts:60

Compare this wrapper's comment against another wrapper.

Parameters​

otherCommentWrapper​

CommentWrapper

Returns​

boolean

Inherited from​

CommentWrapper.commentIsEqual


equal()​

equal(other): boolean

Defined in: full-date.ts:46

Compare two full dates for equality. Two full dates are equal if both their Calendar Round and Long Count components are equal.

Parameters​

other​

IPart

Returns​

boolean

Implementation of​

IPart.equal


equalWithComment()​

equalWithComment(otherCommentWrapper): boolean

Defined in: comment-wrapper.ts:67

Check equality including the associated comment.

Parameters​

otherCommentWrapper​

IPart

Returns​

boolean

Inherited from​

CommentWrapper.equalWithComment


isPartial()​

isPartial(): boolean

Defined in: full-date.ts:38

Determine if either component contains wildcards.

Returns​

boolean


resetComment()​

resetComment(): this

Defined in: comment-wrapper.ts:20

Reset the current comment back to an empty comment.

Returns​

this

Inherited from​

CommentWrapper.resetComment


setComment()​

setComment(comment): this

Defined in: comment-wrapper.ts:28

Replace the current comment.

Parameters​

comment​

string | Comment

Returns​

this

Inherited from​

CommentWrapper.setComment


toString()​

toString(): string

Defined in: full-date.ts:31

Render the full date as a string containing both components.

Returns​

string