baseui/datepicker/utils/types.d.ts

A React Component library implementing the Base design language

type DateValues<T> = T | string | number;
export type DateInput<T> = DateValues<T>;
type Comparison<T> = (value: T, comparing: T) => boolean;
type DateInDateOut<T> = (value: T) => T;
type DateFunc<T> = (a: DateInput<T> | void) => T;
export type AdapterOptions = {
    locale?: unknown;
    formats?: {
        [key: string]: string;
    };
    instance?: unknown;
};
export type DateIOAdapter<T> = {
    locale?: unknown;
    formats: {
        [key: string]: string;
    };
    date: DateFunc<T>;
    toJsDate(value: DateInput<T>): Date;
    parse(value: string, format: string): T;
    getCurrentLocaleCode(): string;
    is12HourCycleInCurrentLocale(): boolean;
    isNull(value?: T): boolean;
    isValid(value: unknown): boolean;
    getDiff: (from: T, to: T) => number;
    isEqual: Comparison<T>;
    isSameDay: Comparison<T>;
    isSameMonth: Comparison<T>;
    isSameYear: Comparison<T>;
    isSameHour: Comparison<T>;
    isAfter: Comparison<T>;
    isAfterDay: Comparison<T>;
    isAfterYear: Comparison<T>;
    isBeforeDay: Comparison<T>;
    isBeforeYear: Comparison<T>;
    isBefore: Comparison<T>;
    startOfMonth: DateInDateOut<T>;
    endOfMonth: DateInDateOut<T>;
    startOfWeek: DateInDateOut<T>;
    endOfWeek(value: T): T;
    addDays(value: T, count: number): T;
    addMonths(value: T, count: number): T;
    isWithinRange(value: T, range: T[]): boolean;
    startOfDay: DateInDateOut<T>;
    endOfDay: DateInDateOut<T>;
    format(value: T, formatKey: string): string;
    formatByString(value: T, formatString: string): string;
    formatNumber(numberToFormat: string): string;
    getHours(value: T): number;
    setHours(value: T, count: number): T;
    getMinutes(value: T): number;
    setMinutes(value: T, count: number): T;
    getSeconds(value: T): number;
    setSeconds(value: T, count: number): T;
    getMonth(value: T): number;
    setMonth(value: T, count: number): T;
    getNextMonth: DateInDateOut<T>;
    getPreviousMonth: DateInDateOut<T>;
    getMonthArray(value: T): T[];
    getYear(value: T): number;
    setYear(value: T, count: number): T;
    mergeDateAndTime(date: T, time: T): T;
    getWeekdays(): string[];
    getWeekArray(date: T): T[][];
    getYearRange(start: T, end: T): T[];
    /** Allow to customize displaying "am/pm" strings */
    getMeridiemText(ampm: 'am' | 'pm'): string;
};
export {};