Skip to content

Commit

Permalink
docs(DateTime): document that year, month, day should be integer
Browse files Browse the repository at this point in the history
  • Loading branch information
djcsdy committed Feb 15, 2024
1 parent 7310813 commit c6b682c
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export interface DateTime {
readonly type: "DateTime";

/** The year.
*
* Should be an integer.
*
* Positive values represent years in the Common Era (CE/AD). For example
* `2024` represents 2024 CE, the year this module was first published to
Expand All @@ -34,10 +36,10 @@ export interface DateTime {
* 1 BCE was immediately followed by 1 CE. */
year: number;

/** The month of the year. Should be in the range `1`-`12`. */
/** The month of the year. Should be an integer in the range `1`-`12`. */
month: number;

/** The day of the month. Should be in the range `1`-`31`. */
/** The day of the month. Should be an integer in the range `1`-`31`. */
day: number;

/** The hours component of the time of day. Should be an integer in the
Expand Down

0 comments on commit c6b682c

Please sign in to comment.