Sanity Library Reference Docs
    Preparing search index...

    Interface LocaleWeekInfo

    An object representing week information associated with the Locale data specified in UTS 35's Week Elements

    interface LocaleWeekInfo {
        firstDay: 1 | 6 | 7;
        minimalDays: 1 | 2 | 3 | 4 | 5 | 6 | 7;
        weekend: (1 | 2 | 3 | 4 | 5 | 6 | 7)[];
    }
    Index

    Properties

    firstDay: 1 | 6 | 7

    An integer indicating the first day of the week for the locale. Can be either 1 (Monday), 6 (Saturday) or 7 (Sunday).

    minimalDays: 1 | 2 | 3 | 4 | 5 | 6 | 7

    An integer between 1 and 7 indicating the minimal days required in the first week of a month or year, for calendar purposes.

    weekend: (1 | 2 | 3 | 4 | 5 | 6 | 7)[]

    An array of integers indicating the weekend days for the locale, where 1 is Monday and 7 is Sunday.