@dxtmisha/functional-basic 0.1.0

package/dist/functions/getKey.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the pressed key.
+ *
+ * Возвращает нажатую клавишу.
+ * @param event event object/ объект события
+ */
+export declare function getKey(event: KeyboardEvent): string;

package/dist/functions/getLengthOfAllArray.d.ts

@@ -0,0 +1,8 @@
+import { ObjectOrArray } from '../types/basicTypes';
+/**
+ * Returns the length of all elements in an array.
+ *
+ * Возвращает длину всех элементов в виде массива.
+ * @param value input value/ входное значение
+ */
+export declare function getLengthOfAllArray(value: ObjectOrArray<string>): number[];

package/dist/functions/getMaxLengthAllArray.d.ts

@@ -0,0 +1,8 @@
+import { ObjectOrArray } from '../types/basicTypes';
+/**
+ * Searches for the longest string in the array and returns its length.
+ *
+ * Ищет самую длинную строку в массиве и возвращает её длину.
+ * @param data array with data/ массив с данными
+ */
+export declare function getMaxLengthAllArray(data: ObjectOrArray<string>): number;

package/dist/functions/getMinLengthAllArray.d.ts

@@ -0,0 +1,8 @@
+import { ObjectOrArray } from '../types/basicTypes';
+/**
+ * Searches for the shortest string in the array and returns its length.
+ *
+ * Ищет самую короткую строку в массиве и возвращает её длину.
+ * @param data array with data/ массив с данными
+ */
+export declare function getMinLengthAllArray(data: ObjectOrArray<string>): number;

package/dist/functions/getMouseClient.d.ts

@@ -0,0 +1,8 @@
+import { ImageCoordinator } from '../types/basicTypes';
+/**
+ * Returns the position of the mouse cursor or the location of the click.
+ *
+ * Возвращает позицию курсора мыши или место нажатия.
+ * @param event event object/ объект события
+ */
+export declare function getMouseClient(event: MouseEvent & TouchEvent): ImageCoordinator;

package/dist/functions/getMouseClientX.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the position of the mouse cursor or the location of the click (X).
+ *
+ * Возвращает позицию курсора мыши или место нажатия (X).
+ * @param event event object/ объект события
+ */
+export declare function getMouseClientX(event: MouseEvent & TouchEvent): number;

package/dist/functions/getMouseClientY.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the position of the mouse cursor or the location of the click (Y).
+ *
+ * Возвращает позицию курсора мыши или место нажатия (Y).
+ * @param event event object/ объект события
+ */
+export declare function getMouseClientY(event: MouseEvent & TouchEvent): number;

package/dist/functions/getObjectByKeys.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a new object with keys from the keys list.
+ *
+ * Возвращает новый объект с ключами из списка keys.
+ * @param data object with data/ объект с данными
+ * @param keys list of keys/ список ключей
+ */
+export declare function getObjectByKeys(data: Record<string, any>, keys: string[]): Record<string, any>;

package/dist/functions/getObjectNoUndefined.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Removes from the object all properties belonging to the exception type.
+ *
+ * Удаляет из объекта все свойства, принадлежащие к типу исключения.
+ * @param data object for processing/ объект для обработки
+ * @param exception exception value/ значение для исключения
+ */
+export declare function getObjectNoUndefined<T extends Record<string | number, any>>(data: T, exception?: any): T;

package/dist/functions/getObjectOrNone.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the object if the object’s values are set.
+ *
+ * Возвращает объект, если заданы значения объекта.
+ * @param value let’s assume that this is an object/ предположим, что это объект
+ */
+export declare function getObjectOrNone<T>(value: T): T & Record<string, any>;

package/dist/functions/getRandomText.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generates text.
+ *
+ * Генерирует текст.
+ * @param min minimum word/ минимальное слово
+ * @param max maximum word/ максимальное слово
+ * @param symbol symbol for replacing a letter/ символ для замены буквы
+ * @param lengthMin minimum word length/ минимальная длина слова
+ * @param lengthMax maximum word length/ максимальная длина слова
+ */
+export declare function getRandomText(min: number, max: number, symbol?: string, lengthMin?: number, lengthMax?: number): string;

package/dist/functions/getRequestString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns a string in the form of key-value.
+ *
+ * Возвращает строку в виде ключ-значение.
+ * @param request data for conversion/ данные для преобразования
+ * @param sign delimiter sign of key and value/ знак разделения ключа и значения
+ * @param separator variable delimiter sign/ знак разделения переменных
+ */
+export declare function getRequestString(request: Record<string, any>, sign?: string, separator?: string): string;

package/dist/functions/getStepPercent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the unit of measurement for 1 step
+ *
+ * Возвращает единицу измерения для 1 шага
+ * @param min minimum value/ минимальное значение
+ * @param max maximum value/ максимальное значение
+ */
+export declare function getStepPercent(min: number | undefined, max: number): number;

package/dist/functions/getStepValue.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns the unit of measurement for a single step relative to the given value
+ *
+ * Возвращает единицу измерения одного шага относительно заданного значения
+ * @param min minimum value/ минимальное значение
+ * @param max maximum value/ максимальное значение
+ */
+export declare function getStepValue(min: number | undefined, max: number): number;

package/dist/functions/goScroll.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Quick change of scroll at the element to the required element.
+ *
+ * Быстрое изменение скролла у элемента к нужному элементу.
+ * @param selector the selected element, the scroll position of which needs to be changed/
+ * выбранный элемент, положение скролла которого надо изменить
+ * @param elementTo the element to which you need to scroll/ элемент, до которого надо проскроллить
+ * @param elementCenter the element that needs to be centered/ элемент, который надо центрировать
+ */
+export declare function goScroll(selector: string, elementTo: HTMLElement | undefined, elementCenter?: HTMLElement): void;

package/dist/functions/inArray.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if the value is in the current array.
+ *
+ * Проверяет, есть ли значение в текущем массиве.
+ * @param array array for checking/ массив для проверки
+ * @param value value to be checked/ проверяемое значение
+ */
+export declare function inArray<T>(array: T[], value: T): boolean;

package/dist/functions/initScrollbarOffset.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Initialization of data for scroll control.
+ *
+ * Инициализация данных для управления скроллом.
+ */
+export declare function initScrollbarOffset(): Promise<void>;

package/dist/functions/intersectKey.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Computes the intersection of arrays using keys for comparison.
+ *
+ * Вычислить пересечение массивов, сравнивая ключи.
+ * @param data the array with master keys to check/ основной проверяемый массив
+ * @param comparison arrays to compare keys against/ массивы, с которыми идёт сравнение
+ */
+export declare function intersectKey<T, KT extends keyof T, C, KC extends keyof C>(data?: T, comparison?: C): Record<KT & KC, T[KT]>;

package/dist/functions/isArray.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the values are arrays.
+ *
+ * Проверяет, являются ли значения массивами.
+ * @param value input value/ входное значение
+ */
+export declare function isArray<T, R>(value: T): value is Extract<T, R[]>;

package/dist/functions/isDifferent.d.ts

@@ -0,0 +1,9 @@
+import { ObjectItem } from '../types/basicTypes';
+/**
+ * Checks if the values of two objects are different.
+ *
+ * Проверяет, различаются ли значения двух объектов.
+ * @param value current values/ текущие значения
+ * @param old old values/ старые значения
+ */
+export declare function isDifferent<T>(value: ObjectItem<T>, old: ObjectItem<T>): boolean;

package/dist/functions/isDomRuntime.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Проверяет, выполняется ли код в браузере, где доступен объект `window`.
+ * Возвращает `true`, если `window` доступен, что означает, что код выполняется в браузере.
+ *
+ * Checks if the code is running in a browser where the `window` object is available.
+ * Returns `true` if `window` is defined, indicating the code is running in a browser.
+ *
+ * @returns `true`, если выполняется в браузере, иначе `false`/ `true` if running in a browser, otherwise `false`
+ */
+export declare function isDomRuntime(): boolean;

package/dist/functions/isFilled.d.ts

@@ -0,0 +1,9 @@
+import { EmptyValue } from '../types/basicTypes';
+/**
+ * Checks if the field is filled.
+ *
+ * Проверяет, заполнено ли поле.
+ * @param value input value/ входное значение
+ * @param zeroTrue if true, '0' is considered filled/ если true, то '0' считается заполненным
+ */
+export declare function isFilled<T>(value: T, zeroTrue?: boolean): value is Exclude<T, EmptyValue>;

package/dist/functions/isFloat.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the value is an integer or a floating-point number.
+ *
+ * Проверяет, является ли значение числом или дробным числом.
+ * @param value values for checking/ значения для проверки
+ */
+export declare function isFloat(value: any): boolean;

package/dist/functions/isFunction.d.ts

@@ -0,0 +1,8 @@
+import { FunctionArgs } from '../types/basicTypes';
+/**
+ * Checks if the function is a callback function.
+ *
+ * Проверяет, является ли функция обратного вызова.
+ * @param callback the value being checked/ проверяемое значение
+ */
+export declare function isFunction<T>(callback: T): callback is Extract<T, FunctionArgs<any, any>>;

package/dist/functions/isInDom.d.ts

@@ -0,0 +1,8 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Checks if an element is still in the DOM tree.
+ *
+ * Проверяет, находится ли еще элемент в дереве DOM.
+ * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
+ */
+export declare function isInDom<E extends ElementOrWindow>(element?: ElementOrString<E>): boolean;

package/dist/functions/isIntegerBetween.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if the value is between integers.
+ *
+ * Проверяет, лежит ли значение между целыми числами.
+ * @param value input value/ входное значение
+ * @param between value for rounding/ значение для округления
+ */
+export declare function isIntegerBetween(value: number, between: number): boolean;

package/dist/functions/isNull.d.ts

@@ -0,0 +1,8 @@
+import { Undefined } from '../types/basicTypes';
+/**
+ * Is the variable equal to null or undefined.
+ *
+ * Является ли переменная равной null или undefined.
+ * @param value input value/ входное значение
+ */
+export declare function isNull<T>(value: T): value is Extract<T, Undefined>;

package/dist/functions/isNumber.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the value is a number.
+ *
+ * Проверяет, является ли значение числом.
+ * @param value values for checking/ значения для проверки
+ */
+export declare function isNumber(value: any): boolean;

package/dist/functions/isObject.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if a value is an object.
+ *
+ * Проверяет, является ли значение объектом.
+ * @param value input value/ входное значение
+ */
+export declare function isObject<T>(value: T): value is Extract<T, Record<any, any>>;

package/dist/functions/isObjectNotArray.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the value is an object or not an array.
+ *
+ * Проверяет, является ли значение объектом и не является массивом.
+ * @param value input value/ входное значение
+ */
+export declare function isObjectNotArray<T>(value: T): value is Exclude<Extract<T, Record<any, any>>, any[] | undefined | null>;

package/dist/functions/isSelected.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if value is in the array selected or if value equals selected, if selected is a string.
+ *
+ * Проверяет, есть ли value в массиве selected или равен ли value selected, если selected - строка.
+ * @param value input value/ входное значение
+ * @param selected array or string for comparison/ массив или строка для сравнения
+ */
+export declare function isSelected<T, S>(value: T, selected: T | T[] | S): boolean;

package/dist/functions/isSelectedByList.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Testing isSelected property for the entire list of values.
+ *
+ * Проверка свойства isSelected для всех значений списка.
+ * @param values list of values for comparison/ список значений для сравнения
+ * @param selected array or string for comparison/ массив или строка для сравнения
+ */
+export declare function isSelectedByList<T>(values: T | T[], selected: T | T[]): boolean;

package/dist/functions/isString.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if the value is of type string.
+ *
+ * Проверяет, является ли значение типом строки.
+ * @param value input value/ входное значение
+ */
+export declare function isString<T>(value: T): value is Extract<T, string>;

package/dist/functions/isWindow.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if object is Window.
+ *
+ * Проверяет, является ли объект Window.
+ * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
+ */
+export declare function isWindow<E>(element: E): element is Extract<E, Window>;

package/dist/functions/random.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generate a random integer.
+ *
+ * Генерирует случайное число.
+ * @param min the lowest value to return/ наименьшее значение
+ * @param max the highest value to return/ наибольшее значение
+ */
+export declare function random(min: number, max: number): number;

package/dist/functions/replaceRecursive.d.ts

@@ -0,0 +1,10 @@
+import { ObjectItem, ObjectOrArray } from '../types/basicTypes';
+/**
+ * Merge one or more arrays recursively.
+ *
+ * Рекурсивное слияние одного или более массивов.
+ * @param array the array in which elements are replaced/ массив, элементы которого будут заменены
+ * @param replacement arrays from which elements will be extracted/ массивы, из которых будут браться элементы для замены
+ * @param isMerge merge one or more arrays/ сливает один или большее количество массивов
+ */
+export declare function replaceRecursive<I>(array: ObjectItem<I>, replacement?: ObjectOrArray<I>, isMerge?: boolean): ObjectItem<I>;

package/dist/functions/replaceTemplate.d.ts

@@ -0,0 +1,9 @@
+import { FunctionReturn } from '../types/basicTypes';
+/**
+ * Replacing the value from replaces in value.
+ *
+ * Замена значения из replaces в value.
+ * @param value template string/ строка шаблона
+ * @param replaces object with data for replacement/ объект с данными для замены
+ */
+export declare function replaceTemplate(value: string, replaces: Record<string, string | FunctionReturn<string>>): string;

package/dist/functions/secondToTime.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts seconds into a time string.
+ *
+ * Преобразовывает секунды в строку с временем.
+ * @param second specified seconds/ указанные секунды
+ */
+export declare function secondToTime(second: number | string | undefined): string;

package/dist/functions/setElementItem.d.ts

@@ -0,0 +1,10 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Modifies the value of an element identified by its key.
+ *
+ * Изменяет значение элемента, определенного ключом.
+ * @param element checked element/ проверяемый элемент
+ * @param index index at which we retrieve values/ индекс, по которому получаем значения
+ * @param value new value/ новое значение
+ */
+export declare function setElementItem<E extends ElementOrWindow, K extends keyof E, V extends E[K] = E[K]>(element: ElementOrString<E>, index: K, value: V | Record<string, V>): E | undefined;

package/dist/functions/setValues.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Modifies data according to its type and settings.
+ *
+ * Изменяет данные в соответствии с их типом и настройками.
+ * @param selected base values/ базовые значения
+ * @param value new values/ новые значения
+ * @param multiple support for multiple values/ поддержка нескольких значений
+ * @param maxlength maximum values/ максимальные значения
+ * @param alwaysChange updating values in any case/ обновление значений при любом случае
+ * @param notEmpty do not make the values empty/ не делать значения пустыми
+ */
+export declare function setValues<T>(selected: T | T[] | undefined, value: any, { multiple, maxlength, alwaysChange, notEmpty }: {
+    multiple?: boolean | undefined;
+    maxlength?: number | undefined;
+    alwaysChange?: boolean | undefined;
+    notEmpty?: boolean | undefined;
+}): T | T[] | undefined;

package/dist/functions/splice.d.ts

@@ -0,0 +1,12 @@
+import { ObjectItem } from '../types/basicTypes';
+/**
+ * This method is used to copy the values of all enumerable own properties from one source object to a target object.
+ * In priority according to the processing list.
+ *
+ * Метод используется для копирования значений всех перечисляемых свойств одного объекта в другой.
+ * В приоритете по списку обработки.
+ * @param array the target object/ целевой объект
+ * @param replacement the source object/ исходные объекты
+ * @param indexStart index at which to start changing the array/ индекс, по которому начинает изменять массив
+ */
+export declare function splice<I>(array: ObjectItem<I>, replacement?: ObjectItem<I> | I, indexStart?: string): ObjectItem<I>;

package/dist/functions/strFill.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The method creates a string of length count, consisting of the characters value.
+ *
+ * Метод создает строку длиной count, состоящую из символов value.
+ * @param value character for filling/ символ для заполнения
+ * @param count length of the string/ длина строки
+ */
+export declare function strFill(value: string, count: number): string;

package/dist/functions/toArray.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Преобразует значение в массив.
+ * Если переданное значение уже является массивом, возвращается оно само.
+ * В противном случае значение оборачивается в массив.
+ *
+ * Converts a value to an array.
+ * If the value is already an array, it returns it as is.
+ * Otherwise, it wraps the value in an array.
+ *
+ * @param value - Значение, которое необходимо преобразовать в массив.
+ *
+ * The value to be converted into an array.
+ * @returns Массив, содержащий переданное значение.
+ *
+ * An array containing the provided value.
+ */
+export declare function toArray<T>(value: T): T extends any[] ? T : [T];

package/dist/functions/toCamelCase.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert a String to Camel Case (upper).
+ *
+ * Преобразование строки в Camel Case (upper).
+ * @param value input value/ входное значение
+ */
+export declare function toCamelCase(value: string): string;

package/dist/functions/toCamelCaseFirst.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Convert a String to Camel Case (+ first letter).
+ *
+ * Преобразование строки в Camel Case (+ первая буква).
+ * @param value input value/ входное значение
+ */
+export declare function toCamelCaseFirst(value: string): string;

package/dist/functions/toDate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Conversion to Date object.
+ *
+ * Преобразование в объект Date.
+ * @param value input value/ входное значение
+ */
+export declare function toDate<T extends Date | number | string>(value?: T): (T & Date) | Date;

package/dist/functions/toKebabCase.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Преобразует строку в формат kebab-case.
+ * Преобразует все заглавные буквы в строчные, заменяет пробелы и другие символы на дефисы.
+ *
+ * Converts a string to kebab-case.
+ * It converts uppercase letters to lowercase, replaces spaces and other characters with dashes.
+ *
+ * @param value - Строка, которую необходимо преобразовать.
+ *
+ * The string to be converted.
+ * @returns Строка в формате kebab-case.
+ *
+ * The string in kebab-case format.
+ */
+export declare function toKebabCase(value: string): string;

package/dist/functions/toNumber.d.ts

@@ -0,0 +1,8 @@
+import { NumberOrString } from '../types/basicTypes';
+/**
+ * The method parses a string argument and returns a floating point number.
+ *
+ * Метод принимает строку в качестве аргумента и возвращает десятичное число
+ * @param value input value/ входное значение
+ */
+export declare function toNumber<T extends NumberOrString>(value?: T): (T & number) | number;

package/dist/functions/toNumberByMax.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts the data into a number, taking into account the maximum permissible value.<br>
+ * Преобразует данные в число с учетом максимально допустимого значения.
+ * @param value input value /<br>входное значение
+ * @param max maximum achievable value /<br>максимально достижимое значение
+ * @param formatting format the number /<br>форматировать число
+ * @param language formatting language /<br>язык форматирования
+ */
+export declare function toNumberByMax(value: string | number, max?: string | number, formatting?: boolean, language?: string): string | number;

package/dist/functions/toPercent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts values to percentages
+ *
+ * Преобразует значения в проценты
+ * @param maxValue maximum value/ максимальное значение
+ * @param value current value/ текущее значение
+ */
+export declare function toPercent(maxValue: number, value: number): number;

package/dist/functions/toPercentBy100.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts values to percentages (three-digit)
+ *
+ * Преобразует значения в проценты (трёхзначный)
+ * @param maxValue maximum value/ максимальное значение
+ * @param value current value/ текущее значение
+ */
+export declare function toPercentBy100(maxValue: number, value: number): number;

package/dist/functions/transformation.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Преобразует строку в соответствующий тип данных.
+ * В зависимости от содержания строки, она может быть преобразована в
+ * `undefined`, `null`, `true`, `false`, объект, число или функцию.
+ *
+ * Transforms a string into the corresponding data type.
+ * Based on the string content, it may be transformed into `undefined`,
+ * `null`, `true`, `false`, object, number, or function.
+ *
+ * @param value - Значение, которое необходимо преобразовать
+ *
+ * The value to be transformed
+ * @param isFunction - Флаг, который указывает, необходимо ли проверять функцию
+ * в глобальном объекте window
+ *
+ * A flag that indicates whether to check for a function in the global window object
+ * @returns Преобразованное значение
+ *
+ * The transformed value
+ */
+export declare function transformation(value: any, isFunction?: boolean): any;

package/dist/functions/uniqueArray.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Removes duplicate entries in an array.
+ *
+ * Удаляет повторяющиеся записи в массиве.
+ * @param value input value/ входное значение
+ */
+export declare function uniqueArray<T>(value: T[]): T[];

package/dist/functions/writeClipboardData.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Writes data to the buffer.
+ *
+ * Записывает данные в буфер.
+ * @param text text for recording/ текст для записи
+ */
+export declare function writeClipboardData(text: string): Promise<void>;