@phensley/cldr-core/lib/internals/internals.d.ts

Core library for @phensley/cldr

import { AltType, CurrencyType, DateFieldType, DayPeriodType, PluralType, Schema, UnitInfo, UnitType } from '@phensley/cldr-schema';
import { CurrencyFormatOptions, CurrencySymbolWidthType, DecimalFormatOptions, ListPatternType, Quantity, RelativeTimeFormatOptions, UnitFormatOptions } from '../common';
import { CalendarDate, CalendarType } from '../systems/calendars';
import { NumberParams } from '../common/private';
import { DateTimeNode } from '../parsing/patterns/date';
import { NumberPattern } from '../parsing/patterns/number';
import { WrapperNode } from '../parsing/patterns/wrapper';
import { Bundle } from '../resource';
import { CalendarContext, CalendarFormatter } from './calendars/formatter';
import { Renderer } from '../utils/render';
import { Decimal, DecimalArg, NumberOperands, Part } from '../types';
export interface CalendarInternals {
    getCalendarFormatter(type: CalendarType): CalendarFormatter<CalendarDate>;
    flexDayPeriod(bundle: Bundle, minutes: number): DayPeriodType | undefined;
    parseDatePattern(raw: string): DateTimeNode[];
    getHourPattern(raw: string, negative: boolean): DateTimeNode[];
    weekFirstDay(region: string): number;
    weekMinDays(region: string): number;
    selectCalendar(bundle: Bundle, ca?: CalendarType): CalendarType;
    formatDateTime<R>(calendar: CalendarType, ctx: CalendarContext<CalendarDate>, renderer: Renderer<R>, date?: DateTimeNode[], time?: DateTimeNode[], wrapper?: string): R;
    formatInterval<R>(calendar: CalendarType, bundle: Bundle, params: NumberParams, renderer: Renderer<R>, start: CalendarDate, end: CalendarDate, pattern: DateTimeNode[]): R;
}
export interface DateFieldInternals {
    formatRelativeTime(bundle: Bundle, start: CalendarDate, end: CalendarDate, options: RelativeTimeFormatOptions, params: NumberParams): string;
    formatRelativeTimeField(bundle: Bundle, value: DecimalArg, field: DateFieldType, options: RelativeTimeFormatOptions, params: NumberParams): string;
}
export interface GeneralInternals {
    characterOrder(bundle: Bundle): string;
    lineOrder(bundle: Bundle): string;
    formatList(bundle: Bundle, items: string[], type: ListPatternType): string;
    formatListToParts(bundle: Bundle, items: string[], type: ListPatternType): Part[];
    formatListToPartsImpl(bundle: Bundle, items: Part[][], type: ListPatternType): Part[];
    getScriptDisplayName(bundle: Bundle, code: string): string;
    getRegionDisplayName(bundle: Bundle, code: string, alt?: AltType): string;
}
export interface NumberInternals {
    stringRenderer(params: NumberParams): NumberRenderer<string>;
    partsRenderer(params: NumberParams): NumberRenderer<Part[]>;
    formatDecimal<T>(bundle: Bundle, renderer: NumberRenderer<T>, n: Decimal, options: DecimalFormatOptions, params: NumberParams): [T, PluralType];
    formatCurrency<T>(bundle: Bundle, renderer: NumberRenderer<T>, n: Decimal, code: string, options: CurrencyFormatOptions, params: NumberParams): T;
    getCurrencySymbol(bundle: Bundle, code: CurrencyType, width?: CurrencySymbolWidthType): string;
    getCurrencyDisplayName(bundle: Bundle, code: CurrencyType): string;
    getCurrencyPluralName(bundle: Bundle, code: string, plural: PluralType): string;
    getNumberPattern(raw: string, negative: boolean): NumberPattern;
}
export interface PluralInternals {
    cardinal(language: string, operands: NumberOperands): PluralType;
    ordinal(language: string, operands: NumberOperands): PluralType;
}
export interface UnitInternals {
    getDisplayName(bundle: Bundle, name: UnitType, length: string): string;
    getUnitInfo(length: string): UnitInfo;
    format<T>(bundle: Bundle, renderer: NumberRenderer<T>, q: Quantity, options: UnitFormatOptions, params: NumberParams): T;
}
export interface WrapperInternals {
    format(format: string, args: string[]): string;
    formatParts(format: string, args: Part[][]): Part[];
    parseWrapper(format: string): WrapperNode[];
}
export interface NumberRenderer<R> {
    empty(): R;
    make(type: string, value: string): R;
    render(n: Decimal, pattern: NumberPattern, currencySymbol: string, percentSymbol: string, minInt: number, grouping?: boolean): R;
    wrap(internal: WrapperInternals, raw: string, ...args: R[]): R;
}
/**
 * Unified interface for accessing internal functionality.
 */
export interface Internals {
    readonly calendars: CalendarInternals;
    readonly dateFields: DateFieldInternals;
    readonly general: GeneralInternals;
    readonly numbers: NumberInternals;
    readonly plurals: PluralInternals;
    readonly schema: Schema;
    readonly units: UnitInternals;
    readonly wrapper: WrapperInternals;
}