maya-dates

@drewsonne/maya-dates / Exports / CommentWrapper

Class: CommentWrapper

Mixin providing comment functionality for domain objects.

Hierarchy

• CommentWrapper

  ↳ FullDate

  ↳ Wildcard

  ↳ CalendarRound

  ↳ Haab

  ↳ Tzolkin

  ↳ DistanceNumber

  ↳ CalendarRoundWildcard

  ↳ LongCountWildcard

  ↳ FullDateWildcard

  ↳ LongcountOperation

Table of contents

Constructors

• constructor

Properties

• comment

Methods

• appendComment
• commentIsEqual
• equalWithComment
• setComment

Constructors

constructor

• Protected new CommentWrapper()

Defined in

comment-wrapper.ts:13

Properties

comment

• comment: Comment

Attached comment.

Defined in

comment-wrapper.ts:11

Methods

appendComment

▸ appendComment(comment): any

Append additional text to the current comment.

Parameters

Name	Type
comment	string | Comment

Returns

any

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

Defined in

comment-wrapper.ts:52

---

equalWithComment

▸ equalWithComment(otherCommentWrapper): boolean

Check equality including the associated comment.

Parameters

Name	Type
otherCommentWrapper	IPart

Returns

boolean

Defined in

comment-wrapper.ts:59

---

setComment

▸ setComment(comment): any

Replace the current comment.

Parameters

Name	Type
comment	string | Comment

Returns

any

Defined in

comment-wrapper.ts:20