@dxtmisha/functional-basic 1.1.5 → 1.1.7

package/dist/classes/GeoIntl.d.ts

@@ -0,0 +1,304 @@
+import { ErrorCenterInstance } from './ErrorCenterInstance';
+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 интернационализации ECMАСcript, предоставляющим
+ * языка-зависимое сравнение строк, форматирование чисел и дат со временем. Конструкторы объектов
+ * Collator, NumberFormat и DateTimeFormat являются свойствами объекта Intl. На этой странице
+ * описаны эти свойства, а также общая функциональность конструкторов интернационализации и других
+ * языка-зависимых функций
+ */
+export declare class GeoIntl {
+    private errorCenter;
+    /**
+     * Checks if an instance of the class exists for the specified country code.
+     *
+     * Проверяет, существует ли экземпляр класса для указанного кода страны.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    static isItem(code?: string): boolean;
+    /**
+     * Returns the standard location code.
+     *
+     * Возвращает стандартный код местоположения.
+     * @param code country code, full form language-country or one of them/
+     * код страны, полный вид язык-страна или один из них
+     */
+    static getLocation(code?: string): string;
+    /**
+     * 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/
+     * код страны, полный вид язык-страна или один из них
+     * @param errorCenter error center instance/ экземпляр центра ошибок
+     */
+    constructor(code?: string, errorCenter?: ErrorCenterInstance);
+    /**
+     * 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 display names/ используемый стиль отображения имен
+     * @returns display name of language/ отображаемое имя языка
+     */
+    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 display names/ используемый стиль отображения имен
+     * @returns display name of region/ отображаемое имя региона
+     */
+    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-часовое время
+     * @returns formatted date and time/ отформатированная дата и время
+     */
+    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/ текущий день
+     * @returns formatted relative time/ отформатированное относительное время
+     */
+    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.
+     *
+     * Названия месяцев.
+     * @param value the date to format/ дата для форматирования
+     * @param style the representation of the month/ представление месяца
+     * @returns month name/ название месяца
+     */
+    month(value?: NumberOrStringOrDate, style?: Intl.DateTimeFormatOptions['month']): string;
+    /**
+     * Array to list of months.
+     *
+     * Массив в список месяцев.
+     * @param style the representation of the month/ представление месяца
+     * @returns list of months (1-12)/ список месяцев (1-12)
+     */
+    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/ представление о дне недели
+     * @returns weekday name/ название дня недели
+     */
+    weekday(value?: NumberOrStringOrDate, style?: Intl.DateTimeFormatOptions['weekday']): string;
+    /**
+     * Array of the list of names of the days of the week.
+     *
+     * Массив из списка названий дней недели.
+     * @param style the representation of the weekday/ представление о дне недели
+     * @returns list of weekdays (0-6)/ список дней недели (0-6)
+     */
+    weekdays(style?: Intl.DateTimeFormatOptions['weekday']): ItemValue<number | undefined>[];
+    /**
+     * Time.
+     *
+     * Время.
+     * @param value the date to format/ дата для форматирования
+     * @returns formatted time/ отформатированное время
+     */
+    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/ функция для сортировки
+     * @returns sorted array/ отсортированный массив
+     */
+    sort<T>(data: T[], compareFn?: (a: T, b: T) => [string, string]): T[];
+    /**
+     * Checks if the Intl object is available.
+     *
+     * Проверяет доступность объекта Intl.
+     */
+    private hasIntl;
+    /**
+     * Checks if the Intl.DateTimeFormat object is available.
+     *
+     * Проверяет доступность объекта Intl.DateTimeFormat.
+     */
+    private hasIntlDateTimeFormat;
+    /**
+     * 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;
+}

package/dist/classes/GeoPhone.d.ts

@@ -0,0 +1,108 @@
+import { GeoPhoneValue, GeoPhoneMap, GeoPhoneMapInfo } from '../types/geoTypes';
+/**
+ * A class for storing and processing phone number masks.
+ *
+ * Класс для хранения и обработка маски телефона.
+ */
+export declare class GeoPhone {
+    protected static list?: GeoPhoneValue[];
+    protected static map?: Record<string, GeoPhoneMap>;
+    /**
+     * Getting an object with information about the phone code and country.
+     *
+     * Получение объекта с информацией о телефонном коде и стране.
+     * @param code country and language code/ код страны и языка
+     */
+    static get(code: string): GeoPhoneValue | undefined;
+    /**
+     * Getting information by phone.
+     *
+     * Получение информации по телефону.
+     * @param phone phone number/ номер телефон
+     */
+    static getByPhone(phone: string): GeoPhoneMapInfo;
+    /**
+     * Retrieves complete mask data by country code.
+     *
+     * Получает полные данные о маске по коду страны.
+     * @param code country and language code/ код страны и языка
+     */
+    static getByCode(code: string): GeoPhoneMap | undefined;
+    /**
+     * We get an array from a list of all phone numbers.
+     *
+     * Получаем массив из списка всех телефонных кодов.
+     */
+    static getList(): GeoPhoneValue[];
+    /**
+     * We get a map of a tree, sorted by its code.
+     *
+     * Получаем карту дерева, отсортированную по его коду.
+     */
+    static getMap(): Record<string, GeoPhoneMap>;
+    /**
+     * Convert to phone mask.
+     *
+     * Преобразовать в маску телефона.
+     * @param phone phone number/ номер телефон
+     * @param masks a mask to transform a phone number/ маска для преобразования номер телефон
+     */
+    static toMask(phone: string, masks?: string[]): string | undefined;
+    /**
+     * Deletes the country code from the input number.
+     *
+     * Удаляет код страны по входному номеру.
+     * @param phone phone number/ номер телефон
+     */
+    static removeZero(phone: string): string;
+    /**
+     * Returns the symbol by the internal country code.
+     *
+     * Возвращает символ по коду внутри страны.
+     * @param within internal country code/ код внутри страны
+     */
+    protected static getWithinSymbol(within: number | string): string;
+    /**
+     * Deletes all characters that do not belong to the mask.
+     *
+     * Удаляет все символы, не относящиеся к маске.
+     * @param mask A mask to transform a phone number/ маска для преобразования номер телефон
+     */
+    protected static getUnnecessaryLength(mask: string): number;
+    /**
+     * Creating a list for the map.
+     *
+     * Формирование списка данных.
+     */
+    protected static makeList(): void;
+    /**
+     * Creating a map for search.
+     *
+     * Создание карты для поиска.
+     */
+    protected static makeMap(): void;
+    /**
+     * The method parses a string argument and returns an array of numbers as strings.
+     *
+     * Метод принимает строку в качестве аргумента и возвращает массив цифр в виде строк.
+     * @param value the value to parse/ текстовая строка
+     * @returns array of numbers/ массив цифр
+     */
+    protected static toNumber(value: string): string[];
+    /**
+     * Converts the phone to a standard.
+     *
+     * Преобразовывает телефон в стандарт.
+     * @param phone phone number/ номер телефон
+     * @param mask a mask to transform a phone number/ маска для преобразования номер телефон
+     */
+    protected static toStandard(phone: string, mask: string): string;
+    /**
+     * Replaces the first character with the internal country code
+     *
+     * Заменяет первый символ на код внутри страны.
+     * @param mask a mask to transform a phone number/ маска для преобразования номер телефон
+     * @param within internal country code/ код внутри страны
+     */
+    protected static toWithin(mask: string, within: number | string): string;
+}

package/dist/classes/Global.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Static utility class for storing and retrieving application-wide global data.
+ *
+ * Статический служебный класс для хранения и получения глобальных данных приложения.
+ */
+export declare class Global {
+    /**
+     * Returns the instance of the class.
+     *
+     * Возвращает инстанс класса.
+     * @returns global data storage / хранилище глобальных данных
+     */
+    static getItem(): Record<string, any>;
+    /**
+     * Returns the value by its name.
+     *
+     * Возвращает значение по его имени.
+     * @param name property name/ название свойства
+     */
+    static get<R = any>(name: string): R;
+    /**
+     * Adds data, this method works only once.
+     *
+     * Добавляет данные, этот метод работает только 1 раз.
+     * @param data global data/ глобальные данные
+     * @returns void
+     */
+    static add(data: Record<string, any>): void;
+}

package/dist/classes/Hash.d.ts

@@ -0,0 +1,57 @@
+import { HashInstance } from './HashInstance';
+/**
+ * Static class for working with data stored in the URL hash.
+ * Provides a centralized interface delegating to HashInstance.
+ *
+ * Статический класс для работы с данными, сохранёнными в хеше URL.
+ * Предоставляет централизованный интерфейс, делегируя вызовы HashInstance.
+ */
+export declare class Hash {
+    /**
+     * Returns a request-isolated instance of HashInstance.
+     *
+     * Возвращает изолированный в рамках запроса экземпляр HashInstance.
+     * @returns HashInstance instance / экземпляр HashInstance
+     */
+    static getItem(): HashInstance;
+    /**
+     * Get data from hash.
+     *
+     * Получение данных из хэша.
+     * @param name variable name / название переменной
+     * @param defaultValue value or function to change data / значение или функция для изменения данных
+     * @returns stored value / сохранённое значение
+     */
+    static get<T>(name: string, defaultValue?: T | (() => T)): T;
+    /**
+     * Change data in hash.
+     *
+     * Изменение данных в хэше.
+     * @param name variable name / название переменной
+     * @param callback value or function to change data / значение или функция для изменения данных
+     */
+    static set<T>(name: string, callback: T | (() => T)): void;
+    /**
+     * Adding an event when data is changed.
+     *
+     * Добавление события при изменении данных.
+     * @param name variable name / название переменной
+     * @param callback the function is called when the data is changed / функция вызывается при изменении данных
+     */
+    static addWatch<T>(name: string, callback: (value: T) => void): void;
+    /**
+     * Removing an event when data is changed.
+     *
+     * Удаление события при изменении данных.
+     * @param name variable name / название переменной
+     * @param callback the function is called when the data is changed / функция вызывается при изменении данных
+     */
+    static removeWatch<T>(name: string, callback: (value: T) => void): void;
+    /**
+     * Update hash variable from URL string.
+     *
+     * Обновление переменной хэша из строки URL.
+     * @returns void
+     */
+    static reload(): void;
+}

package/dist/classes/HashInstance.d.ts

@@ -0,0 +1,95 @@
+/**
+ * Class for working with data stored in the URL hash.
+ *
+ * Класс для работы с данными, сохранёнными в хеше URL.
+ */
+export declare class HashInstance {
+    private hash?;
+    private watch;
+    private block;
+    private time?;
+    /**
+     * Get data from hash.
+     *
+     * Получение данных из хэша.
+     * @param name variable name / название переменной
+     * @param defaultValue value or function to change data / значение или функция для изменения данных
+     * @returns stored value / сохранённое значение
+     */
+    get<T>(name: string, defaultValue?: T | (() => T)): T;
+    /**
+     * Change data in hash.
+     *
+     * Изменение данных в хэше.
+     * @param name variable name / название переменной
+     * @param callback value or function to change data / значение или функция для изменения данных
+     * @returns this instance / текущий экземпляр
+     */
+    set<T>(name: string, callback: T | (() => T)): this;
+    /**
+     * Adding an event when data is changed.
+     *
+     * Добавление события при изменении данных.
+     * @param name variable name / название переменной
+     * @param callback the function is called when the data is changed / функция вызывается при изменении данных
+     * @returns this instance / текущий экземпляр
+     */
+    addWatch<T>(name: string, callback: (value: T) => void): this;
+    /**
+     * Removing an event when data is changed.
+     *
+     * Удаление события при изменении данных.
+     * @param name variable name / название переменной
+     * @param callback the function is called when the data is changed / функция вызывается при изменении данных
+     * @returns this instance / текущий экземпляр
+     */
+    removeWatch<T>(name: string, callback: (value: T) => void): this;
+    /**
+     * Update hash variable from URL string.
+     *
+     * Обновление переменной хэша из строки URL.
+     * @returns this instance / текущий экземпляр
+     */
+    reload(): this;
+    /**
+     * Obtaining data from the URL string.
+     *
+     * Получение данных из строки URL.
+     * @returns Record<string, any> hash data / данные хэша
+     */
+    private getLocation;
+    /**
+     * Returns the hash object, initializing if needed.
+     *
+     * Возвращает объект хэша, инициализируя при необходимости.
+     * @returns Record<string, any> hash object / объект хэша
+     */
+    private getHash;
+    /**
+     * Initializes hash data and registers the hashchange listener.
+     *
+     * Инициализирует данные хэша и регистрирует слушатель hashchange.
+     * @returns this instance / текущий экземпляр
+     */
+    private init;
+    /**
+     * Reads hash data from the URL and triggers watchers.
+     *
+     * Считывает данные хэша из URL и вызывает наблюдателей.
+     * @returns this instance / текущий экземпляр
+     */
+    private initData;
+    /**
+     * Update hash string in URL.
+     *
+     * Обновление строки хэша в URL.
+     */
+    private update;
+    /**
+     * Calling all functions whose data has changed.
+     *
+     * Вызов всех функций, у которых были изменены данные.
+     * @param location fresh data / свежие данные
+     */
+    private makeWatch;
+}