@dxtmisha/functional-basic 1.1.0 → 1.1.6

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,9 @@
+/**
+ * Generate a random integer.
+ *
+ * Генерирует случайное число.
+ * @param min the lowest value to return/ наименьшее значение
+ * @param max the highest value to return/ наибольшее значение
+ * @returns random number/ случайное число
+ */
+export declare function random(min: number, max: number): number;

package/dist/functions/removeCommonPrefix.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Removes the common prefix from the main string.
+ *
+ * Убирает общий префикс из основной строки.
+ * @param mainStr - The main string / Основная строка
+ * @param prefix - The prefix string to remove / Строка префикса для удаления
+ * @returns string without prefix / строка без префикса
+ */
+export declare function removeCommonPrefix(mainStr: string, prefix: string): string;

package/dist/functions/replaceComponentName.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Replaces the component name in the text.
+ *
+ * Заменяет имя компонента в тексте.
+ * @param text text/ текст
+ * @param name component name/ имя компонента
+ * @param componentName new component name/ новое имя компонента
+ */
+export declare const replaceComponentName: (text: string | undefined, name: string, componentName: string) => string | undefined;

package/dist/functions/replaceRecursive.d.ts

@@ -0,0 +1,11 @@
+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/ сливает один или большее количество массивов
+ * @returns merged object/ объединенный объект
+ */
+export declare function replaceRecursive<I>(array: ObjectItem<I>, replacement?: ObjectOrArray<I>, isMerge?: boolean): ObjectItem<I>;

package/dist/functions/replaceTemplate.d.ts

@@ -0,0 +1,10 @@
+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/ объект с данными для замены
+ * @returns replaced string/ замененная строка
+ */
+export declare function replaceTemplate(value: string, replaces: Record<string, string | FunctionReturn<string>>): string;

package/dist/functions/resizeImageByMax.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Resize type for image scaling.
+ *
+ * Тип изменения размера для масштабирования изображения.
+ */
+type ResizeImageByMaxType = 'auto' | 'width' | 'height';
+/**
+ * Resizes an image to fit within a maximum size constraint.
+ *
+ * Изменяет размер изображения в соответствии с ограничением максимального размера.
+ * @param image image element or URL / элемент изображения или URL
+ * @param maxSize maximum size for width or height / максимальный размер ширины или высоты
+ * @param type resize type (auto, width, height) / тип изменения размера (auto, width, height)
+ * @param typeData optional data type for the resulting image /
+ * необязательный тип данных для результирующего изображения
+ * @returns base64 image string or undefined / строка base64 изображения или undefined
+ */
+export declare function resizeImageByMax(image: HTMLImageElement | string, maxSize: number, type?: ResizeImageByMaxType, typeData?: string): string | undefined;
+export {};

package/dist/functions/secondToTime.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts seconds into a time string.
+ *
+ * Преобразовывает секунды в строку с временем.
+ * @param second specified seconds/ указанные секунды
+ * @param hasHour whether to include hours/ нужно ли указывать часы
+ * @returns string formatted time/ форматированная строка с временем
+ */
+export declare function secondToTime(second: number | string | undefined, hasHour?: boolean): string;

package/dist/functions/setElementItem.d.ts

@@ -0,0 +1,11 @@
+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/ новое значение
+ * @returns modified element/ измененный элемент
+ */
+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,18 @@
+/**
+ * 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/ не делать значения пустыми
+ * @returns modified values/ измененные значения
+ */
+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/sleep.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Pause execution for a specified number of milliseconds.
+ *
+ * Приостановить выполнение на указанное количество миллисекунд.
+ * @param ms milliseconds/ миллисекунды
+ * @returns promise that resolves after delay/ промис, который разрешается после задержки
+ */
+export declare function sleep(ms: number): Promise<void>;

package/dist/functions/splice.d.ts

@@ -0,0 +1,13 @@
+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/ индекс, по которому начинает изменять массив
+ * @returns modified 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,9 @@
+/**
+ * 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/ длина строки
+ * @returns filled string/ заполненная строка
+ */
+export declare function strFill(value: string, count: number): string;

package/dist/functions/strSplit.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Splits a string by a separator, limited to a certain number of elements.
+ * If a limit is specified, the last element will contain the remainder of the string.
+ *
+ * Разделяет строку по разделителю, ограничивая количество элементов.
+ * Если указан лимит, последний элемент будет содержать остаток строки.
+ * @param value input value/ входное значение
+ * @param separator separator/ разделитель
+ * @param limit limit/ лимит
+ * @returns split array/ разделенный массив
+ */
+export declare function strSplit(value: number | string, separator: string, limit?: 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,8 @@
+/**
+ * Convert a String to Camel Case (upper).
+ *
+ * Преобразование строки в Camel Case (upper).
+ * @param value input value/ входное значение
+ * @returns camel case string/ строка в camel case
+ */
+export declare function toCamelCase(value: string): string;

package/dist/functions/toCamelCaseFirst.d.ts

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

package/dist/functions/toDate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Conversion to Date object.
+ *
+ * Преобразование в объект Date.
+ * @param value input value/ входное значение
+ * @returns date object/ объект даты
+ */
+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,19 @@
+import { NumberOrString } from '../types/basicTypes';
+/**
+ * Converts a string or number to a finite floating-point number.
+ * Handles various separators (spaces, commas, dots) and strips non-numeric characters.
+ * Safe for use in SSR (Server-Side Rendering) environments.
+ *
+ * Преобразует строку или число в конечное число с плавающей точкой.
+ * Обрабатывает различные разделители (пробелы, запятые, точки) и удаляет нечисловые символы.
+ * Безопасно для использования в SSR (Server-Side Rendering) средах.
+ *
+ * @param value - The input value to convert / Входное значение для преобразования
+ * @returns The parsed number or 0 if conversion fails / Распарсенное число или 0, если конвертация не удалась
+ *
+ * @example
+ * toNumber("1 234,56") // 1234.56
+ * toNumber("1,234.56") // 1234.56
+ * toNumber("1,234")    // 1.234
+ */
+export declare function toNumber(value?: NumberOrString): number;

package/dist/functions/toNumberByMax.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Converts the data into a number, taking into account the maximum permissible value.
+ *
+ * Преобразует данные в число с учетом максимально допустимого значения.
+ * @param value input value / входное значение
+ * @param max maximum achievable value / максимально достижимое значение
+ * @param formatting format the number / форматировать число
+ * @param language formatting language / язык форматирования
+ * @returns formatted number string or number/ форматированная строка числа или число
+ */
+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,9 @@
+/**
+ * Converts values to percentages
+ *
+ * Преобразует значения в проценты
+ * @param maxValue maximum value/ максимальное значение
+ * @param value current value/ текущее значение
+ * @returns percentage value / значение в процентах
+ */
+export declare function toPercent(maxValue: number, value: number): number;

package/dist/functions/toPercentBy100.d.ts

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

package/dist/functions/toString.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts the given value to a string. Returns an empty string if the value is null or undefined.
+ *
+ * Преобразование значения в строку. Возвращает пустую строку, если значение равно null или undefined.
+ * @param value value for conversion / значение для преобразования
+ * @returns string representation of the value / строковое представление значения
+ */
+export declare function toString<T>(value: T): string;

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/uint8ArrayToBase64.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a Uint8Array to a base64 encoded string.
+ *
+ * Преобразует Uint8Array в строку, закодированную в base64.
+ * @param bytes binary data as Uint8Array / бинарные данные в виде Uint8Array
+ * @returns base64 encoded string / строка, закодированная в base64
+ */
+export declare function uint8ArrayToBase64(bytes: Uint8Array): string;

package/dist/functions/uniqueArray.d.ts

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

package/dist/functions/writeClipboardData.d.ts

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