@box/cldr-data/types.d.ts

CLDR Data that box-ui-elements and other Box code needs

/**
 * Define the types exported by the cldr-data project
 */

export interface NumberFormat {
    digits: number;
    msg: string;
}

export interface NumbersData {
    short: Array<NumberFormat>;
    long: Array<NumberFormat>;
}

export interface NameItem {
    id: number;
    name: string;
}

export interface LanguagesData {
    id: number;
    bcp47Tag: string;
    name: string;
    localizedName: string;
    localizedNameList: Array<NameItem>;
}

export interface TimeZone {
    name: string;
    nameLocalized: string;
    abbreviationStandard: string;
    abbreviationDaylight?: string;
    displayName: string;
    id: number;
    enabled?: boolean;
}

export type TimeZoneList = Array<TimeZone>;

export interface WeekDayNames {
    mon: string;
    tue: string;
    wed: string;
    thu: string;
    fri: string;
    sat: string;
    sun: string;
}

export interface NameSet {
    abbreviated: WeekDayNames;
    narrow: WeekDayNames;
    short: WeekDayNames;
    wide: WeekDayNames;
}

export interface WeekDayNameData {
    days: NameSet;
    standAlone: NameSet;
}

export interface WeekData {
    firstDay: number;
    weekendStart: number;
    weekendEnd: number;
}

export interface LocaleData {
    languages: LanguagesData;
    numbers: NumbersData;
    timezones: TimeZoneList;
    weekData: WeekData;
    weekDayNames: WeekDayNameData;
}

export declare function loadLocaleData(locale: string): Promise<LocaleData>;