Skip to content

Commit dbefff5

Browse files
committed
Add examples for types
1 parent c3e3834 commit dbefff5

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

packages/date/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Check whether a date is considered in the future according to the WordPress sett
134134

135135
_Parameters_
136136

137-
- _dateValue_ `Date | string`: Date String or Date object in the Defined WP Timezone.
137+
- _dateValue_ `Date | string | number`: Date String or Date object in the Defined WP Timezone.
138138

139139
_Returns_
140140

packages/date/src/types.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,25 @@ export type L10nSettings = {
7777

7878
/**
7979
* Locale months.
80+
*
81+
* @example
82+
* ['January', 'February', ... ]
8083
*/
8184
months: MomentLocaleSpecification[ 'months' ];
8285

8386
/**
8487
* Locale months short.
88+
*
89+
* @example
90+
* ['Jan', 'Feb', ... ]
8591
*/
8692
monthsShort: MomentLocaleSpecification[ 'monthsShort' ];
8793

8894
/**
8995
* Locale weekdays.
96+
*
97+
* @example
98+
* ['Sunday', 'Monday', ... ]
9099
*/
91100
weekdays: MomentLocaleSpecification[ 'weekdays' ];
92101

0 commit comments

Comments
 (0)