@dxtmisha/functional-basic 0.1.1 → 0.1.4

package/src/functions/forEach.ts

@@ -1,39 +0,0 @@
-import { isObject } from './isObject'
-
-/**
- * The function performs the specified function once for each element in the object.
- * And returns an array with the results of executing the function.
- *
- * Функция выполняет указанную функцию один раз для каждого элемента в объекте.
- * И возвращает массив с результатами выполнения функции.
- * @param data object for iteration/ объект для перебора
- * @param callback a function to execute for each element in the array/
- * функция, которая будет вызвана для каждого элемента
- */
-export function forEach<
-  T,
-  R,
-  D extends T[] | Record<string, T> | Map<string, T> = T[] | Record<string, T> | Map<string, T>,
-  K = D extends T[] ? number : string
->(
-  data: D & (T[] | Record<string, T> | Map<string, T>),
-  callback: (item: T, key: K, dataMain: typeof data) => R
-): R[] {
-  if (isObject(data)) {
-    const returnData: R[] = []
-
-    if (data instanceof Map) {
-      data.forEach((item: T, key) => returnData.push(callback(item, key as K, data)))
-    } else if (Array.isArray(data)) {
-      data.forEach((item: T, key) => returnData.push(callback(item, key as K, data)))
-    } else {
-      Object.entries(data).forEach(
-        ([key, item]) => returnData.push(callback(item, key as K, data))
-      )
-    }
-
-    return returnData.filter((item: R | undefined) => item !== undefined)
-  }
-
-  return []
-}

package/src/functions/frame.ts

@@ -1,38 +0,0 @@
-import { isDomRuntime } from './isDomRuntime'
-
-/**
- * Cyclically calls requestAnimationFrame until next returns true
- * The window.requestAnimationFrame() method tells the browser that you wish to perform
- * an animation and requests that the browser calls a specified function to update an
- * animation right before the next repaint.
- *
- * Циклически вызывает requestAnimationFrame, пока next возвращает true
- * window.requestAnimationFrame указывает браузеру на то, что вы хотите произвести
- * анимацию, и просит его запланировать перерисовку на следующем кадре анимации.
- * @param callback the function to call when it's time to update your animation for the next repaint/ функция,
- * которая будет вызвана, когда придёт время обновить вашу анимацию на следующей перерисовке
- * @param next function that determines repetition/ функция, которая определяет повторность
- * @param end function that is executed if the animation stops/ функция,
- * которая выполняется, если останавливается анимация
- */
-export function frame(
-  callback: () => void,
-  next?: () => boolean,
-  end?: () => void
-) {
-  const init = () => {
-    callback()
-
-    if (next?.()) {
-      frame(callback, next, end)
-    } else {
-      end?.()
-    }
-  }
-
-  if (isDomRuntime()) {
-    requestAnimationFrame(init)
-  } else {
-    init()
-  }
-}

package/src/functions/getAttributes.ts

@@ -1,27 +0,0 @@
-import { getElement } from './getElement'
-
-import {
-  type ElementOrString,
-  type ElementOrWindow
-} from '../types/basicTypes'
-
-/**
- * Gets a list of attributes of an element.
- *
- * Получает список атрибутов у элемента.
- * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
- */
-export function getAttributes<E extends ElementOrWindow>(
-  element?: ElementOrString<E>
-): Record<string, string | undefined> {
-  const attributes: Record<string, string | undefined> = {}
-  const item = getElement(element)
-
-  if (item) {
-    for (const attribute of item.attributes) {
-      attributes[attribute.name] = (attribute?.value || attribute?.textContent) ?? undefined
-    }
-  }
-
-  return attributes
-}

package/src/functions/getClipboardData.ts

@@ -1,13 +0,0 @@
-/**
- * The method retrieves drag data (as a string) for the specified type.
- * If the drag operation does not include data, this method returns an empty string.
- *
- * Метод извлекает данные перетаскивания (в виде строки) для указанного типа.
- * @param event the ClipboardEvent interface represents events providing information
- * related to modification of the clipboard, that is cut, copy, and paste events/ интерфейс
- * ClipboardEvent представляет события, предоставляющие информацию, связанную с изменением буфера обмена,
- * этими события являются cut, copy и paste.
- */
-export async function getClipboardData(event?: ClipboardEvent): Promise<string> {
-  return event?.clipboardData?.getData('text') ?? (await navigator.clipboard.readText() || '')
-}

package/src/functions/getColumn.ts

@@ -1,18 +0,0 @@
-import { forEach } from './forEach'
-
-import { type ObjectOrArray } from '../types/basicTypes'
-
-/**
- * Returns an array of values for a specific column in the input array.
- *
- * Возвращает массив значений для определенного столбца входного массива.
- * @param array a one array or an array of objects from which to pull a column of values from/
- * многомерный массив или массив объектов, из которого будет производиться выборка значений
- * @param column the column of values to return/ ключ столбца, значения которого нужно вернуть
- */
-export function getColumn<T, K extends keyof T>(
-  array: ObjectOrArray<T>,
-  column: K
-): (T[K] | undefined)[] {
-  return forEach<T, T[K] | undefined>(array, item => item?.[column])
-}

package/src/functions/getElement.ts

@@ -1,35 +0,0 @@
-import { isDomRuntime } from './isDomRuntime'
-import { isString } from './isString'
-import { isWindow } from './isWindow'
-
-import {
-  type ElementOrString,
-  type ElementOrWindow
-} from '../types/basicTypes'
-
-/**
- * Returns the first Element in the document that matches the specified selector or the element.
- *
- * Возвращает первый Element документа, который соответствует указанному селектору или саму element.
- * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
- */
-export function getElement<
-  E extends ElementOrWindow,
-  R extends Exclude<E, Window>
->(
-  element?: ElementOrString<E>
-): R | undefined {
-  if (!isDomRuntime()) {
-    return undefined
-  }
-
-  if (isWindow(element)) {
-    return document.body as R
-  }
-
-  if (isString(element)) {
-    return document.querySelector<R>(element) ?? undefined
-  }
-
-  return element as (R | undefined)
-}

package/src/functions/getElementId.ts

@@ -1,39 +0,0 @@
-import { getElement } from './getElement'
-import { isFilled } from './isFilled'
-import { random } from './random'
-
-import {
-  type ElementOrString,
-  type ElementOrWindow
-} from '../types/basicTypes'
-
-/**
- * Counter generator of ID number of element.
- *
- * Счетчик генератор номера ID элемента.
- */
-let idLast = random(100000, 900000)
-
-/**
- * Returns the identifier (ID) of the element or creates it if the element has no ID.
- *
- * Возвращает идентификатор (ID) элемента или создает его, если у элемента нет ID.
- * @param element element from which you obtain an ID/ элемент, с которого получаете ID
- * @param selector selectors for matching/ селекторов для сопоставления
- */
-export function getElementId<E extends ElementOrWindow>(
-  element?: ElementOrString<E>,
-  selector?: string
-): string {
-  const item = getElement(element)
-
-  if (item) {
-    if (!isFilled(item.id)) {
-      item.setAttribute('id', `id-${idLast++}`)
-    }
-
-    return selector ? `#${item.id}${selector}`.trim() : item.id
-  }
-
-  return `id-${idLast++}`
-}

package/src/functions/getElementItem.ts

@@ -1,27 +0,0 @@
-import { getElement } from './getElement'
-
-import {
-  type ElementOrString,
-  type ElementOrWindow
-} from '../types/basicTypes'
-
-/**
- * Returns the value of an element by its key.
- *
- * Возвращает значение элемента по его ключу.
- * @param element checked element/ проверяемый элемент
- * @param index index at which we retrieve values/ индекс, по которому получаем значения
- * @param defaultValue returns this parameter if the value is missing/ возвращает этот параметр,
- * если значение отсутствует
- */
-export function getElementItem<
-  T extends ElementOrWindow,
-  K extends keyof T,
-  D
->(
-  element: ElementOrString<T>,
-  index: K | string,
-  defaultValue?: D
-): T[K] | D | undefined {
-  return getElement(element)?.[index as K] ?? defaultValue
-}

package/src/functions/getElementOrWindow.ts

@@ -1,23 +0,0 @@
-import { getElement } from './getElement'
-import { isWindow } from './isWindow'
-
-import {
-  type ElementOrString,
-  type ElementOrWindow
-} from '../types/basicTypes'
-
-/**
- * Returns window or element.
- *
- * Возвращает окно или элемент.
- * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
- */
-export function getElementOrWindow<E extends ElementOrWindow>(
-  element?: ElementOrString<E>
-): E | undefined {
-  if (isWindow(element)) {
-    return element
-  }
-
-  return getElement(element)
-}

package/src/functions/getExp.ts

@@ -1,21 +0,0 @@
-/**
- * The object is used for matching text with a pattern.
- *
- * Конструктор создаёт объект регулярного выражения для сопоставления текста с шаблоном.
- * @param value test for replacement/ тест для замены
- * @param flags если определён, может принимать любую комбинацию нижеследующих значений:
- * g - глобальное сопоставление,
- * i - игнорирование регистра при сопоставлении
- * m - сопоставление по нескольким строкам.
- * @param pattern Regular expression text in which the value :value will be replaced with the optimized value of value/
- * Текст регулярного выражения, в котором значение :value заменится на оптимизированное значение value
- */
-export function getExp(
-  value: string,
-  flags = 'ig',
-  pattern = ':value'
-): RegExp {
-  const data = value.replace(/([[\]\\^$.?*+()/])/g, '\\$1')
-
-  return new RegExp(pattern.replace(/:value/g, data), flags)
-}

package/src/functions/getItemByPath.ts

@@ -1,24 +0,0 @@
-import { isObjectNotArray } from './isObjectNotArray'
-
-/**
- * Returns data by their path.
- *
- * Возвращает данные по их пути.
- * @param item object for work/ объект для работы
- * @param path data path/ путь к данным
- */
-export function getItemByPath<T extends Record<string, any>>(item: T, path: string): string {
-  const paths = path.split('.', 2)
-  const column = paths[0]
-
-  if (
-    column
-    && item?.[column]
-    && isObjectNotArray(item[column])
-    && paths?.[1]
-  ) {
-    return getItemByPath(item[column], paths[1])
-  }
-
-  return (column && item?.[column]) ?? ''
-}

package/src/functions/getKey.ts

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

package/src/functions/getLengthOfAllArray.ts

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

package/src/functions/getMaxLengthAllArray.ts

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

package/src/functions/getMinLengthAllArray.ts

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

package/src/functions/getMouseClient.ts

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

package/src/functions/getMouseClientX.ts

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

package/src/functions/getMouseClientY.ts

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

package/src/functions/getObjectByKeys.ts

@@ -1,24 +0,0 @@
-/**
- * Returns a new object with keys from the keys list.
- *
- * Возвращает новый объект с ключами из списка keys.
- * @param data object with data/ объект с данными
- * @param keys list of keys/ список ключей
- */
-export function getObjectByKeys(
-  data: Record<string, any>,
-  keys: string[]
-) {
-  const returnData: Record<string, any> = {}
-
-  keys.forEach((key) => {
-    if (
-      key in data
-      && data[key] !== undefined
-    ) {
-      returnData[key] = data[key]
-    }
-  })
-
-  return returnData
-}

package/src/functions/getObjectNoUndefined.ts

@@ -1,23 +0,0 @@
-import { forEach } from './forEach'
-
-/**
- * Removes from the object all properties belonging to the exception type.
- *
- * Удаляет из объекта все свойства, принадлежащие к типу исключения.
- * @param data object for processing/ объект для обработки
- * @param exception exception value/ значение для исключения
- */
-export function getObjectNoUndefined<T extends Record<string | number, any>>(
-  data: T,
-  exception: any = undefined
-) {
-  const returnData: T = {} as T
-
-  forEach(data, (item, index) => {
-    if (item !== exception) {
-      returnData[index] = item
-    }
-  })
-
-  return returnData
-}

package/src/functions/getObjectOrNone.ts

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

package/src/functions/getRandomText.ts

@@ -1,29 +0,0 @@
-import { random } from './random'
-import { strFill } from './strFill'
-
-/**
- * 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 function getRandomText(
-  min: number,
-  max: number,
-  symbol: string = '#',
-  lengthMin: number = 2,
-  lengthMax: number = 12
-) {
-  const rand = random(min, max)
-  const label: string[] = []
-
-  for (let i = 0; i < rand; i++) {
-    label.push(strFill(symbol, random(lengthMin, lengthMax)))
-  }
-
-  return label.join(' ')
-}

package/src/functions/getRequestString.ts

@@ -1,21 +0,0 @@
-import { forEach } from './forEach'
-
-/**
- * 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 function getRequestString(
-  request: Record<string, any>,
-  sign: string = '=',
-  separator: string = '&'
-): string {
-  return forEach(request,
-    (item, name) => `${name}${sign}${encodeURIComponent(String(item).trim())}`
-  )
-    .sort()
-    .join(separator)
-}

package/src/functions/getStepPercent.ts

@@ -1,19 +0,0 @@
-/**
- * Returns the unit of measurement for 1 step
- *
- * Возвращает единицу измерения для 1 шага
- * @param min minimum value/ минимальное значение
- * @param max maximum value/ максимальное значение
- */
-export function getStepPercent(
-  min: number | undefined,
-  max: number
-): number {
-  const minValue = min ?? 0
-
-  if (max > minValue) {
-    return 100 / (max - minValue)
-  }
-
-  return 0
-}

package/src/functions/getStepValue.ts

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

package/src/functions/goScroll.ts

@@ -1,40 +0,0 @@
-const INDENT = 0
-
-/**
- * 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 function goScroll(
-  selector: string,
-  elementTo: HTMLElement | undefined,
-  elementCenter?: HTMLElement
-) {
-  const element = elementTo?.closest<HTMLElement>(selector)
-
-  if (
-    elementTo
-    && element
-    && element.scrollHeight !== element.offsetHeight
-  ) {
-    if (elementCenter) {
-      const center = elementCenter.getBoundingClientRect()
-      const rect = element.getBoundingClientRect()
-      const to = elementTo.getBoundingClientRect()
-
-      element.scrollTop = elementTo.offsetTop - (center.top - rect.top) - ((center.height / 2) - (to.height / 2))
-
-      if (element.scrollTop + element.offsetHeight < elementTo.offsetTop + elementTo.offsetHeight) {
-        element.scrollTop = elementTo.offsetTop + elementTo.offsetHeight - element.offsetHeight
-      }
-    } else if (element.scrollTop > elementTo.offsetTop) {
-      element.scrollTop = elementTo.offsetTop - INDENT
-    } else if (element.scrollTop + element.offsetHeight < elementTo.offsetTop + elementTo.offsetHeight) {
-      element.scrollTop = elementTo.offsetTop + elementTo.offsetHeight - element.offsetHeight + INDENT
-    }
-  }
-}

package/src/functions/inArray.ts

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

package/src/functions/initScrollbarOffset.ts

@@ -1,14 +0,0 @@
-import { isDomRuntime } from './isDomRuntime'
-import { ScrollbarWidth } from '../classes/ScrollbarWidth'
-
-/**
- * Initialization of data for scroll control.
- *
- * Инициализация данных для управления скроллом.
- */
-export async function initScrollbarOffset() {
-  if (isDomRuntime()) {
-    const width = await ScrollbarWidth.get()
-    document.body.style.setProperty('--sys-scrollbar-offset', `${width}px`)
-  }
-}