@dxtmisha/functional-basic 0.1.0

package/dist/classes/EventItem.d.ts

@@ -0,0 +1,160 @@
+import { ElementOrString, ElementOrWindow, EventActivityItem, EventListenerDetail, EventOptions } from '../types/basicTypes';
+/**
+ * Class for working with events.
+ *
+ * Класс для работы с событиями.
+ */
+export declare class EventItem<E extends ElementOrWindow, O extends Event, D extends Record<string, any> = Record<string, any>> {
+    protected listener?: EventListenerDetail<O, D> | undefined;
+    protected options?: EventOptions;
+    protected detail?: D | undefined;
+    /**
+     * Element.
+     *
+     * Элемент.
+     */
+    protected element?: E;
+    /**
+     * Element for checking. If the element is missing in the DOM, the event is turned off.
+     *
+     * Элемент для проверки. Если элемент отсутствует в DOM, событие выключается.
+     */
+    protected elementControl?: ElementOrWindow;
+    protected elementControlEdit?: boolean;
+    /**
+     * A case-sensitive string representing the event type to listen for.
+     *
+     * Чувствительная к регистру строка, представляющая тип обрабатываемого события.
+     */
+    protected type: string[];
+    /**
+     * The object that receives a notification (an object that implements the Event interface)
+     * when an event of the specified type occurs. This must be null, an object with a
+     * handleEvent() method, or a JavaScript function.
+     *
+     * Объект, который принимает уведомление, когда событие указанного типа произошло.
+     * Это должен быть объект, реализующий интерфейс EventListener или просто функция JavaScript.
+     */
+    protected listenerRecent: (event?: O | ResizeObserverEntry) => void;
+    /**
+     * Event states.
+     *
+     * Состояния события.
+     */
+    protected activity: boolean;
+    protected activityItems: EventActivityItem<E>[];
+    /**
+     * Classes Constructor
+     * @param elementSelector element/ элемент
+     * @param type type/ тип
+     * @param listener the object that receives a notification (an object that implements the
+     * Event interface) when an event of the specified type occurs/ объект, который принимает
+     * уведомление, когда событие указанного типа произошло
+     * @param options object that specifies characteristics/ объект options
+     * @param detail an event-dependent value associated with the event/ зависимое от события
+     * значение, связанное с событием
+     */
+    constructor(elementSelector?: ElementOrString<E>, type?: string | string[], listener?: EventListenerDetail<O, D> | undefined, options?: EventOptions, detail?: D | undefined);
+    /**
+     * Checks whether event listening is currently enabled.
+     *
+     * Проверяет, включено ли сейчас прослушивание события.
+     */
+    isActive(): boolean;
+    getElement(): E | undefined;
+    /**
+     * Change of an element for tracking.
+     *
+     * Изменение элемента для прослеживания.
+     * @param elementSelector element/ элемент
+     */
+    setElement(elementSelector?: ElementOrString<E>): this;
+    /**
+     * Modifies the object that receives the notification.
+     *
+     * Модифицирует объект, который получает уведомление.
+     * @param elementSelector element/ элемент
+     */
+    setElementControl<EC extends HTMLElement>(elementSelector?: ElementOrString<EC>): this;
+    /**
+     * Changes the type of the handled event.
+     *
+     * Изменяет тип обрабатываемого события.
+     * @param type type/ тип
+     */
+    setType(type: string | string[]): this;
+    /**
+     * Modifies the object that receives the notification.
+     *
+     * Модифицирует объект, который получает уведомление.
+     * @param listener
+     */
+    setListener(listener: EventListenerDetail<O, D>): this;
+    /**
+     * Modifying the options object that defines the characteristics of an object.
+     *
+     * Изменение объекта options, который определяет характеристики объекта.
+     * @param options
+     */
+    setOptions(options?: EventOptions): this;
+    /**
+     * Modifying a dependent value for the dispatch method.
+     *
+     * Изменение зависимого значения для метода dispatch.
+     * @param detail
+     */
+    setDetail(detail?: D): this;
+    /**
+     * The method of the EventTarget sends an Event to the object, (synchronously) invoking
+     * the affected EventListeners in the appropriate order.
+     *
+     * Отправляет событие в общую систему событий. Это событие подчиняется тем же правилам
+     * поведения "Захвата" и "Всплывания" как и непосредственно инициированные события.
+     * @param detail an event-dependent value associated with the event/ зависимое от события
+     * значение, связанное с событием
+     */
+    dispatch(detail?: D | undefined): this;
+    /**
+     * Starting event listening.
+     *
+     * Запуск прослушивания события.
+     */
+    start(): this;
+    /**
+     * Stopping event listening.
+     *
+     * Остановка прослушивания события.
+     */
+    stop(): this;
+    /**
+     * Toggling event handler state.
+     *
+     * Переключение состояния работы события.
+     * @param activity event activation/ активация события
+     */
+    toggle(activity: boolean): this;
+    /**
+     * Overloads the listening events.
+     *
+     * Перегружает события прослушивания.
+     */
+    reset(): this;
+    /**
+     * Checks if the ResizeObserver object exists.
+     *
+     * Проверяет, существует ли объект ResizeObserver.
+     */
+    protected isObserver(): boolean;
+    /**
+     * The implementation of the resize event for an element.
+     *
+     * Реализация события изменения размера для элемента.
+     */
+    protected makeResize(): boolean;
+    /**
+     * Implementation of the scroll event for an element.
+     *
+     * Реализация события изменения положения скролла для элемента.
+     */
+    protected makeScroll(): boolean;
+}

package/dist/classes/Geo.d.ts

@@ -0,0 +1,168 @@
+import { GeoItem, GeoItemFull } from '../types/geoTypes';
+/**
+ * Base class for working with geographic data.
+ *
+ * Базовый класс для работы с географическими данными.
+ */
+export declare class Geo {
+    private static storage;
+    private static location;
+    private static item;
+    private static language;
+    private static timezone;
+    /**
+     * Information about the current country.
+     *
+     * Информация об текущей стране.
+     */
+    static get(): GeoItemFull;
+    /**
+     * Current country.
+     *
+     * Текущая страна.
+     */
+    static getCountry(): string;
+    /**
+     * Current language.
+     *
+     * Текущий язык.
+     */
+    static getLanguage(): string;
+    /**
+     * Full format according to the standard.
+     *
+     * Полный формат согласно стандарту.
+     */
+    static getStandard(): string;
+    /**
+     * Returns the first day of the week.
+     *
+     * Возвращает первый день недели.
+     */
+    static getFirstDay(): string;
+    /**
+     * Full format.
+     *
+     * Полный формат.
+     */
+    static getLocation(): string;
+    /**
+     * Obtaining processed data.
+     *
+     * Получение обработанных данных.
+     */
+    static getItem(): GeoItemFull;
+    /**
+     * Returns the full list of countries.
+     *
+     * Возвращает полный список стран.
+     */
+    static getList(): GeoItem[];
+    /**
+     * Returns the data about the country by its full code.
+     *
+     * Возвращает данные о стране по ее полному коду.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    static getByCode(code?: string): GeoItemFull;
+    /**
+     * Returns the full data by language and country.
+     *
+     * Возвращает полные данные по языку и стране.
+     * @param code string in the form of language-country/ строка в виде язык-страна
+     */
+    static getByCodeFull(code: string): GeoItem | undefined;
+    /**
+     * Returns the full data by country.
+     *
+     * Возвращает полные данные по стране.
+     * @param country country/ страна
+     */
+    static getByCountry(country: string): GeoItem | undefined;
+    /**
+     * Returns the full data by language.
+     *
+     * Возвращает полные данные по языку.
+     * @param language language/ язык
+     */
+    static getByLanguage(language: string): GeoItem | undefined;
+    /**
+     * Retrieving the default timezone.
+     *
+     * Получение временной зоны по умолчанию
+     */
+    static getTimezone(): number;
+    /**
+     * Retrieving the default timezone (formatted view).
+     *
+     * Получение временной зоны по умолчанию (отформатированный вид).
+     */
+    static getTimezoneFormat(): string;
+    /**
+     * Determines the current country by its full name.
+     *
+     * Определяет текущую страну по ее полному названию.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    static find(code: string): GeoItemFull;
+    /**
+     * Returns a complete string with the country code and language.
+     *
+     * Возвращает полную строку с кодом страны и языка.
+     * @param item object with data about the current country/
+     * объект с данными об текущей стране
+     */
+    static toStandard(item: GeoItem): string;
+    /**
+     * Changes the data by the full code.
+     *
+     * Изменяет данные по полному коду.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     * @param save save the result/ сохранить результат
+     */
+    static set(code: string, save?: boolean): void;
+    /**
+     * Changing the default timezone for transmitted dates.
+     *
+     * Изменение временной зоны по умолчанию для отправляемых дат
+     * @param timezone new time zone/ новая временная зона
+     */
+    static setTimezone(timezone: number): void;
+    /**
+     * Determines the current location.
+     *
+     * Определяет текущую локацию.
+     */
+    private static findLocation;
+    /**
+     * Determines the current language.
+     *
+     * Определяет текущий язык.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    private static findLanguage;
+    /**
+     * Returns the country code by its full language-country.
+     *
+     * Возвращает код страны по ее полному язык-страна.
+     * @param code country code/ код страна
+     */
+    private static toCountry;
+    /**
+     * Returns the language code by its full language-country.<br>
+     * Возвращает код языка по его полному язык-страна.
+     * @param code country code/ код страна
+     */
+    private static toLanguage;
+    /**
+     * Adding missing data.<br>
+     * Добавление недостающих данных.
+     * @param item object with data about the current country/
+     * объект с данными об текущей стране
+     */
+    private static toFull;
+}

package/dist/classes/GeoFlag.d.ts

@@ -0,0 +1,79 @@
+import { GeoIntl } from './GeoIntl';
+import { GeoFlagItem, GeoFlagNational, GeoItemFull } from '../types/geoTypes';
+export declare const GEO_FLAG_ICON_NAME = "@flag";
+/**
+ * Class for working with Flags.
+ *
+ * Класс для работы с Флагами.
+ */
+export declare class GeoFlag {
+    protected code: string;
+    static flags: Record<string, string>;
+    /**
+     * Constructor
+     * @param code country and language code/ код страны и языка
+     */
+    constructor(code?: string);
+    /**
+     * Returns information about the country and its flag.
+     *
+     * Возвращает информацию о стране и её флаге.
+     * @param code country code/ код страны
+     */
+    get(code?: string): GeoFlagItem | undefined;
+    /**
+     * Getting a link to the flag.
+     *
+     * Получение ссылки на флаг.
+     * @param code country code/ код страны
+     */
+    getFlag(code?: string): string | undefined;
+    /**
+     * Getting a list of countries by an array of codes.
+     *
+     * Получение списка стран по массиву с кодами.
+     * @param codes country code/ код страны
+     */
+    getList(codes?: string[]): GeoFlagItem[];
+    /**
+     * Getting a list of countries by an array of codes in national language.
+     *
+     * Получение списка стран по массиву с кодами на национальный язык.
+     * @param codes country code/ код страны.
+     */
+    getNational(codes?: string[]): GeoFlagNational[];
+    /**
+     * To change the location.
+     *
+     * Изменить местоположение.
+     * @param code country and language code/ код страны и языка
+     */
+    setCode(code: string): this;
+    /**
+     * Returns a special object for formatting.
+     *
+     * Возвращает специальный объект для работы с форматированием.
+     */
+    protected getLocation(): GeoIntl;
+    /**
+     * Returns a list of countries to retrieve data from.
+     *
+     * Возвращает список стран для получения данных.
+     * @param codes country code/ код страны
+     */
+    protected getCodes(codes?: string[]): string[];
+    /**
+     * Getting the name of the language.
+     *
+     * Получение названия языка.
+     * @param data object with information of data/ объект с информацией данных
+     */
+    protected getLanguage(data: GeoItemFull): string;
+    /**
+     * Getting the name of the country.
+     *
+     * Получение названия страны.
+     * @param data object with information of data/ объект с информацией данных
+     */
+    protected getCountry(data: GeoItemFull): string;
+}

package/dist/classes/GeoIntl.d.ts

@@ -0,0 +1,262 @@
+import { NumberOrStringOrDate, NumberOrString, ItemValue } from '../types/basicTypes';
+import { GeoDate } from '../types/geoTypes';
+/**
+ * The Intl namespace object contains several constructors as well as functionality common
+ * to the internationalization constructors and other language sensitive functions. Collectively,
+ * they comprise the ECMAScript Internationalization API, which provides language sensitive
+ * string comparison, number formatting, date and time formatting, and more
+ *
+ * Объект Intl является пространством имён для API интернационализации ECMAScript, предоставляющим
+ * языка-зависимое сравнение строк, форматирование чисел и дат со временем. Конструкторы объектов
+ * Collator, NumberFormat и DateTimeFormat являются свойствами объекта Intl. На этой странице
+ * описаны эти свойства, а также общая функциональность конструкторов интернационализации и других
+ * языка-зависимых функций
+ */
+export declare class GeoIntl {
+    /**
+     * Returns an instance of the class according to the specified country code.
+     *
+     * Возвращает экземпляр класса по указанному коду страны.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    static getInstance(code?: string): GeoIntl;
+    private readonly geo;
+    /**
+     * Constructor
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    constructor(code?: string);
+    /**
+     * Returns country code and language.
+     *
+     * Возвращает код страны и языка.
+     */
+    getLocation(): string;
+    /**
+     * Returns the first day of the week.
+     *
+     * Возвращает первый день недели.
+     */
+    getFirstDay(): string;
+    /**
+     * The consistent translation of language, region and script display names.
+     *
+     * Последовательный перевод отображаемых названий языка, региона и скрипта.
+     * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
+     * @param typeOptions an object with some or all of the following properties/
+     * объект с некоторыми или всеми из следующих свойств
+     */
+    display(value?: string, typeOptions?: Intl.DisplayNamesOptions['type'] | Intl.DisplayNamesOptions): string;
+    /**
+     * Get display names of language.
+     *
+     * Получить отображаемые имена языка.
+     * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
+     * @param style the formatting style to use/ используемый стиль форматирования
+     */
+    languageName(value?: string, style?: Intl.RelativeTimeFormatStyle): string;
+    /**
+     * Get display names of region.
+     *
+     * Получить отображаемые имена региона.
+     * @param value the code to provide depends on the type/ предоставляемый код зависит от типа
+     * @param style the formatting style to use/ используемый стиль форматирования
+     */
+    countryName(value?: string, style?: Intl.RelativeTimeFormatStyle): string;
+    /**
+     * The method returns a string containing the full name in a specific format.
+     *
+     * Метод возвращает строку, содержащую полное имя в определённом формате.
+     * @param last last name/ фамилию
+     * @param first first name/ имя
+     * @param surname surname middle name (optional)/ отчество
+     * @param short shorten the names/ сократить названия
+     */
+    fullName(last: string, first: string, surname?: string, short?: boolean): string;
+    /**
+     * In basic use without specifying a locale, a formatted string.
+     *
+     * При обычном использовании без указания локали форматированная строка.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param options an object with some or all properties/ объект с некоторыми
+     * или всеми свойствами
+     */
+    number(value: NumberOrString, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Decimal point symbol.
+     *
+     * Символ десятичной точки.
+     */
+    decimal(): string;
+    /**
+     * Currency formatting.
+     *
+     * Форматирование валюты.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param currencyOptions the currency to use in currency formatting/
+     * валюта для использования в форматировании валюты
+     * @param numberOnly do not display the currency symbol/ не выводить значок валюты
+     */
+    currency(value: NumberOrString, currencyOptions?: string | Intl.NumberFormatOptions, numberOnly?: boolean): string;
+    /**
+     * Returns the currency symbol if it exists, otherwise the currency code.
+     *
+     * Возвращает символ для валюты, если он есть, или сам код валюты.
+     * @param currency the currency to use in currency formatting/
+     * валюта для использования в форматировании валюты
+     * @param currencyDisplay how to display the currency in currency formatting/
+     * как отобразить валюту в формате валюты
+     */
+    currencySymbol(currency: string, currencyDisplay?: keyof Intl.NumberFormatOptionsCurrencyDisplayRegistry): string;
+    /**
+     * Unit formatting.
+     * If the style is 'unit', a unit property must be provided.
+     *
+     * Форматирование юнитов.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param unitOptions the unit to use in unit formatting/ блок для использования
+     * в форматировании блока
+     */
+    unit(value: NumberOrString, unitOptions?: string | Intl.NumberFormatOptions): string;
+    /**
+     * Возвращает отформатированный размер файла
+     * @param value a number, bigint, or string, to format /<br>число для форматирования
+     * @param unitOptions the unit to use in unit formatting /<br>блок для использования
+     * в форматировании блока
+     */
+    sizeFile(value: NumberOrString, unitOptions?: 'byte' | 'kilobyte' | 'megabyte' | 'gigabyte' | 'terabyte' | 'petabyte' | Intl.NumberFormatOptions): string;
+    /**
+     * Number as a percentage.
+     *
+     * Число в виде процента.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param options an object with some or all properties/ объект с некоторыми или всеми свойствами
+     */
+    percent(value: NumberOrString, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Number as a percentage (unit).
+     *
+     * Число в виде процента (единица).
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param options an object with some or all properties/
+     * объект с некоторыми или всеми свойствами
+     */
+    percentBy100(value: NumberOrString, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Применять форматирование, учитывающее множественное число, и языковые правила, связанные с множественным числом
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param words list of words for formatting (in the format one|two|few|many|other|zero)/
+     * список слов для форматирования (в формате `one|two|few|many|other|zero`)
+     * @param options Property for PluralRules/ свойство для PluralRules
+     * @param optionsNumber an object with some or all properties/ объект с некоторыми или всеми свойствами
+     */
+    plural(value: NumberOrString, words: string, options?: Intl.PluralRulesOptions, optionsNumber?: Intl.NumberFormatOptions): string;
+    /**
+     * Enables language-sensitive date and time formatting.
+     *
+     * Конструктором объектов, включающих языка-зависимое форматирование даты и времени.
+     * @param value the date to format/ дата для форматирования
+     * @param type type of data format/ тип формата data
+     * @param styleOptions the representation of the month/ представление месяца
+     * @param hour24 whether to use 12-hour time/ использовать ли 12-часовое время
+     */
+    date(value: NumberOrStringOrDate, type?: GeoDate, styleOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions, hour24?: boolean): string;
+    /**
+     * Enables language-sensitive relative time formatting.
+     *
+     * Включает форматирование относительного времени с учетом языка.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param styleOptions the length of the internationalized message/
+     * длина интернационализированного сообщения
+     * @param todayValue current day/ текущий день
+     */
+    relative(value: NumberOrStringOrDate, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions, todayValue?: Date): string;
+    /**
+     * Enables language-sensitive relative time formatting
+     * Including the ability to add a limit to output the standard time format if the value
+     * exceeds the allowable limit.
+     *
+     * Включает форматирование относительного времени с учетом языка.
+     * Включая возможность добавления лимита, чтобы выводить уже стандартный формат времени,
+     * если значение вышло за пределы допустимого.
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param limit values that determine the output limit (values per day)/
+     * значения, по которым определяем предел вывода (значения в день)
+     * @param todayValue current day/ текущий день
+     * @param relativeOptions the length of the internationalized message/
+     * длина интернационализированного сообщения
+     * @param dateOptions the representation of the month/ представление месяца
+     * @param type type of data format/ тип формата data
+     * @param hour24 whether to use 12-hour time/ использовать ли 12-часовое время
+     */
+    relativeLimit(value: NumberOrStringOrDate, limit: number, todayValue?: Date, relativeOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions, dateOptions?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions, type?: GeoDate, hour24?: boolean): string;
+    /**
+     * Возвращает отформатированное значение времени, прошедшего с момента события
+     * @param value a number, bigint, or string, to format/ число для форматирования
+     * @param unit time unit/ единица времени
+     * @param styleOptions additional option or formatting style/ дополнительная опция или стиль форматирования
+     */
+    relativeByValue(value: NumberOrString, unit: Intl.RelativeTimeFormatUnit, styleOptions?: Intl.RelativeTimeFormatStyle | Intl.RelativeTimeFormatOptions): string;
+    /**
+     * Names of months.<br>
+     * Названия месяцев.
+     * @param value the date to format/ дата для форматирования
+     * @param style the representation of the month/ представление месяца
+     */
+    month(value?: NumberOrStringOrDate, style?: Intl.DateTimeFormatOptions['month']): string;
+    /**
+     * Array to list of months.
+     *
+     * Массив в список месяцев.
+     * @param style the representation of the month/ представление месяца
+     */
+    months(style?: Intl.DateTimeFormatOptions['month']): ItemValue<number | undefined>[];
+    /**
+     * Returns names of days of the week.
+     *
+     * Возвращает названия дней недели.
+     * @param value the date to format/ дата для форматирования
+     * @param style the representation of the weekday/ представление о дне недели
+     */
+    weekday(value?: NumberOrStringOrDate, style?: Intl.DateTimeFormatOptions['weekday']): string;
+    /**
+     * An array of the list of names of the days of the week.
+     *
+     * Массив из списка названий дней недели.
+     * @param style the representation of the weekday/ представление о дне недели
+     */
+    weekdays(style?: Intl.DateTimeFormatOptions['weekday']): ItemValue<number | undefined>[];
+    /**
+     * Time.
+     *
+     * Время.
+     * @param value the date to format/ дата для форматирования
+     */
+    time(value: NumberOrStringOrDate): string;
+    /**
+     * Sorts strings taking into account the characteristics of countries.
+     *
+     * Сортирует строки с учетом особенностей стран.
+     * @param data an array with data/ массив с данными
+     * @param compareFn a function for sorting/ функция для сортировки
+     */
+    sort<T>(data: T[], compareFn?: (a: T, b: T) => [string, string]): T[];
+    /**
+     * The object enables language-sensitive number formatting.
+     *
+     * Объект включает форматирование чисел с учетом языка.
+     * @param options an object with some or all properties/
+     * объект с некоторыми или всеми свойствами
+     */
+    private numberObject;
+    /**
+     * Returns options for data according to its type.
+     *
+     * Возвращает options для data по его типу.
+     * @param type type of data format/ тип формата data
+     * @param display the representation of the month/ представление месяца
+     */
+    private dateOptions;
+}