diff options
Diffstat (limited to 'intl/icu_capi/js/package/docs/source/week_ffi.rst')
| -rw-r--r-- | intl/icu_capi/js/package/docs/source/week_ffi.rst | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/intl/icu_capi/js/package/docs/source/week_ffi.rst b/intl/icu_capi/js/package/docs/source/week_ffi.rst new file mode 100644 index 0000000000..3bb2f146e8 --- /dev/null +++ b/intl/icu_capi/js/package/docs/source/week_ffi.rst @@ -0,0 +1,49 @@ +``week::ffi`` +============= + +.. js:class:: ICU4XWeekCalculator + + A Week calculator, useful to be passed in to ``week_of_year()`` on Date and DateTime types + + See the `Rust documentation for WeekCalculator <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html>`__ for more information. + + + .. js:function:: create(provider, locale) + + Creates a new :js:class:`ICU4XWeekCalculator` from locale data. + + See the `Rust documentation for try_new <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html#method.try_new>`__ for more information. + + + .. js:function:: create_from_first_day_of_week_and_min_week_days(first_weekday, min_week_days) + + Additional information: `1 <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html#structfield.first_weekday>`__, `2 <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html#structfield.min_week_days>`__ + + + .. js:method:: first_weekday() + + Returns the weekday that starts the week for this object's locale + + See the `Rust documentation for first_weekday <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html#structfield.first_weekday>`__ for more information. + + + .. js:method:: min_week_days() + + The minimum number of days overlapping a year required for a week to be considered part of that year + + See the `Rust documentation for min_week_days <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekCalculator.html#structfield.min_week_days>`__ for more information. + + +.. js:class:: ICU4XWeekOf + + See the `Rust documentation for WeekOf <https://docs.rs/icu/latest/icu/calendar/week/struct.WeekOf.html>`__ for more information. + + + .. js:attribute:: week + + .. js:attribute:: unit + +.. js:class:: ICU4XWeekRelativeUnit + + See the `Rust documentation for RelativeUnit <https://docs.rs/icu/latest/icu/calendar/week/enum.RelativeUnit.html>`__ for more information. + |