Skip to content

Commit cea7b5f

Browse files
Documented weekSettings opt in DateTime (#1640)
1 parent 2008075 commit cea7b5f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/datetime.js

+9
Original file line numberDiff line numberDiff line change
@@ -630,6 +630,7 @@ export default class DateTime {
630630
* @param {string} [options.locale] - a locale to set on the resulting DateTime instance
631631
* @param {string} [options.outputCalendar] - the output calendar to set on the resulting DateTime instance
632632
* @param {string} [options.numberingSystem] - the numbering system to set on the resulting DateTime instance
633+
* @param {string} [options.weekSettings] - the week settings to set on the resulting DateTime instance
633634
* @example DateTime.utc() //~> now
634635
* @example DateTime.utc(2017) //~> 2017-01-01T00:00:00Z
635636
* @example DateTime.utc(2017, 3) //~> 2017-03-01T00:00:00Z
@@ -682,6 +683,7 @@ export default class DateTime {
682683
* @param {string} [options.locale] - a locale to set on the resulting DateTime instance
683684
* @param {string} options.outputCalendar - the output calendar to set on the resulting DateTime instance
684685
* @param {string} options.numberingSystem - the numbering system to set on the resulting DateTime instance
686+
* @param {string} options.weekSettings - the week settings to set on the resulting DateTime instance
685687
* @return {DateTime}
686688
*/
687689
static fromMillis(milliseconds, options = {}) {
@@ -709,6 +711,7 @@ export default class DateTime {
709711
* @param {string} [options.locale] - a locale to set on the resulting DateTime instance
710712
* @param {string} options.outputCalendar - the output calendar to set on the resulting DateTime instance
711713
* @param {string} options.numberingSystem - the numbering system to set on the resulting DateTime instance
714+
* @param {string} options.weekSettings - the week settings to set on the resulting DateTime instance
712715
* @return {DateTime}
713716
*/
714717
static fromSeconds(seconds, options = {}) {
@@ -745,6 +748,7 @@ export default class DateTime {
745748
* @param {string} [opts.locale='system\'s locale'] - a locale to set on the resulting DateTime instance
746749
* @param {string} opts.outputCalendar - the output calendar to set on the resulting DateTime instance
747750
* @param {string} opts.numberingSystem - the numbering system to set on the resulting DateTime instance
751+
* @param {string} opts.weekSettings - the week settings to set on the resulting DateTime instance
748752
* @example DateTime.fromObject({ year: 1982, month: 5, day: 25}).toISODate() //=> '1982-05-25'
749753
* @example DateTime.fromObject({ year: 1982 }).toISODate() //=> '1982-01-01'
750754
* @example DateTime.fromObject({ hour: 10, minute: 26, second: 6 }) //~> today at 10:26:06
@@ -874,6 +878,7 @@ export default class DateTime {
874878
* @param {string} [opts.locale='system's locale'] - a locale to set on the resulting DateTime instance
875879
* @param {string} [opts.outputCalendar] - the output calendar to set on the resulting DateTime instance
876880
* @param {string} [opts.numberingSystem] - the numbering system to set on the resulting DateTime instance
881+
* @param {string} [opts.weekSettings] - the week settings to set on the resulting DateTime instance
877882
* @example DateTime.fromISO('2016-05-25T09:08:34.123')
878883
* @example DateTime.fromISO('2016-05-25T09:08:34.123+06:00')
879884
* @example DateTime.fromISO('2016-05-25T09:08:34.123+06:00', {setZone: true})
@@ -895,6 +900,7 @@ export default class DateTime {
895900
* @param {string} [opts.locale='system's locale'] - a locale to set on the resulting DateTime instance
896901
* @param {string} opts.outputCalendar - the output calendar to set on the resulting DateTime instance
897902
* @param {string} opts.numberingSystem - the numbering system to set on the resulting DateTime instance
903+
* @param {string} opts.weekSettings - the week settings to set on the resulting DateTime instance
898904
* @example DateTime.fromRFC2822('25 Nov 2016 13:23:12 GMT')
899905
* @example DateTime.fromRFC2822('Fri, 25 Nov 2016 13:23:12 +0600')
900906
* @example DateTime.fromRFC2822('25 Nov 2016 13:23 Z')
@@ -915,6 +921,7 @@ export default class DateTime {
915921
* @param {string} [opts.locale='system's locale'] - a locale to set on the resulting DateTime instance
916922
* @param {string} opts.outputCalendar - the output calendar to set on the resulting DateTime instance
917923
* @param {string} opts.numberingSystem - the numbering system to set on the resulting DateTime instance
924+
* @param {string} opts.weekSettings - the week settings to set on the resulting DateTime instance
918925
* @example DateTime.fromHTTP('Sun, 06 Nov 1994 08:49:37 GMT')
919926
* @example DateTime.fromHTTP('Sunday, 06-Nov-94 08:49:37 GMT')
920927
* @example DateTime.fromHTTP('Sun Nov 6 08:49:37 1994')
@@ -935,6 +942,7 @@ export default class DateTime {
935942
* @param {boolean} [opts.setZone=false] - override the zone with a zone specified in the string itself, if it specifies one
936943
* @param {string} [opts.locale='en-US'] - a locale string to use when parsing. Will also set the DateTime to this locale
937944
* @param {string} opts.numberingSystem - the numbering system to use when parsing. Will also set the resulting DateTime to this numbering system
945+
* @param {string} opts.weekSettings - the week settings to set on the resulting DateTime instance
938946
* @param {string} opts.outputCalendar - the output calendar to set on the resulting DateTime instance
939947
* @return {DateTime}
940948
*/
@@ -973,6 +981,7 @@ export default class DateTime {
973981
* @param {boolean} [opts.setZone=false] - override the zone with a zone specified in the string itself, if it specifies one
974982
* @param {string} [opts.locale='en-US'] - a locale string to use when parsing. Will also set the DateTime to this locale
975983
* @param {string} opts.numberingSystem - the numbering system to use when parsing. Will also set the resulting DateTime to this numbering system
984+
* @param {string} opts.weekSettings - the week settings to set on the resulting DateTime instance
976985
* @param {string} opts.outputCalendar - the output calendar to set on the resulting DateTime instance
977986
* @example DateTime.fromSQL('2017-05-15')
978987
* @example DateTime.fromSQL('2017-05-15 09:12:34')

0 commit comments

Comments
 (0)