@saqqdy/common

# Установка через npm
npm install --save @saqqdy/common
# Или установка через yarn
yarn add @saqqdy/common

# Добавьте следующую строку в вашем .vue или main.js файле
import { trim, getOsVersion, ... } from '@saqqdy/common'
# Использование
trim(somestring, type) // Возвращает строку без пробелов
getOsVersion()  // Возвращает версию операционной системы
...

# Добавьте следующую строку в вашем main.js файле
require('@saqqdy/common')

# Добавьте следующий тег script в ваш HTML-код, используя CDN-ссылку
<script src="http://cdn.saqqdy.com/common.min.js"></script>

// Глобальные параметры
client, // Метод client возвращает объект, содержащий информацию о браузере
pattern, // Метод pattern возвращает набор часто используемых регулярных выражений
```// Расширения String и методы массивов
trim, // Удаляет пробелы в зависимости от переданных параметров
clearAttr, // Удаляет все атрибуты HTML-тегов
clearBr, // Удаляет символы новой строки
clearHtml, // Удаляет HTML-теги
clearHtmlExpSN, // Удаляет HTML-теги, сохраняя пробелы и символы новой строки
clearHtmlN, // Удаляет HTML-теги и символы новой строки
clearHtmlNS, // Удаляет HTML-теги и пробелы
clearHtmlTag, // Удаляет HTML-теги и текст внутри них
getNumber, // Извлекает числа из строки
imgAdapt, // Расширяет изображение для соответствия разным разрешениям small original
imgChoose, // Расширяет изображение для соответствия разным разрешениям @2x @3x
camel2Dash, // Преобразует строку в формат Dash (нижнее подчеркивание) из camelCase
dash2Camel, // Преобразует строку из формата Dash (нижнее подчеркивание) в camelCase
getRandomNum, // Возвращает случайное целое число
getRandomStr, // Возвращает случайную строку
getRandomStrWidthSpecialChar, // Возвращает случайную строку с символами специального типа
getCHSLength, // Возвращает длину строки, где каждый китайский символ считается за два символа
cutCHSString, // Обрезает строку, где каждый китайский символ считается за два символа
textareaInsertText, // Вставляет текст в textarea или input объект в указанной позиции курсора
textareaMoveToEnd, // Перемещает курсор в конец textarea или input объекта

```// Получить текущее состояние
isDigitals, // является ли строка, состоящей только из цифр
isExistsFunction, // существует ли указанный функцией метод
```isExistsVariable, // существует ли указанный переменной метод
getWindowSize, // getWindowSize получает размер окна
getAppVersion, // получает версию приложения
getOsVersion, // получает версию операционной системы устройства
getIsAppVersionLatest, // сравнивает версию приложения с последней версией
getDirParam, // получает параметры URL в виде директории
getParameter, // получает отдельный параметр URL
getFileType, // получает расширение файла
getUrlParam, // получает параметры URL
formatTime, // плагин для форматирования дат
formatTimeStr // форматирование времени в: "только что", "несколько минут назад"// Кэш, cookie, сессия
setCookie, // метод записи cookie
setLocal, // запись в localStorage
setSession, // запись в sessionStorage
getCookie, // чтение cookie
getLocal, // чтение из localStorage
getSession, // чтение из sessionStorage
delCookie, // удаление cookie
delLocal, // удаление из localStorage
delSession, // удаление из sessionStorage

// Кодирование и декодирование
encodeBase64, // преобразование строк и чисел в base64
encodeUtf8, // кодирование в UTF-8
decodeBase64, // декодирование base64
decodeUtf8, // декодирование UTF-8
enWxJumpLink, // замена = на *, & на ! для кодирования ссылки для перехода в WeChat
enWxJumpLinkOld, // замена = на ~, & на ^ для кодирования ссылки для перехода в WeChat
deWxJumpLink, // замена * на =, ! на & для декодирования ссылки для перехода в WeChat
deWxJumpLinkOld, // замена ~ на =, ^ на & для декодирования ссылки для перехода в WeChat

// Дебаунс и тайпинг
debounce, // контроль простоя: если время простоя больше или равно delay, fn будет выполнено
throttle, // контроль частоты: fn будет выполнено один раз за определенное время

// Делегирование событий, другие методы событий
stopBubble, // предотвращение всплытия
stopDefault, // предотвращение по умолчанию
addEvent, // делегирование событий, поддерживает многократное делегирование
removeEvent, // удаление делегирования событий, созданного с помощью addEvent
getScrollPosition, // получение позиции прокрутки до верха и до низа, возвращает 'top' 'bottom', рекомендуется использовать тайпинг```markdown
<dl>
  <dt><a href="#addEvent">addEvent(element, type, handler)</a></dt>
  <dd><p>addEvent() — событие делегирования, поддерживает множественное делегирование</p>
  </dd>
  <dt><a href="#handleEvent">handleEvent(event)</a> ⇒ <code>Boolean</code></dt>
  <dd><p>handleEvent() — выполнение события</p>
  </dd>
  <dt><a href="#fixEvent">fixEvent(event)</a> ⇒ <code>Object</code></dt>
  <dd><p>Добавляет некоторые "отсутствующие" функции объекту события для IE</p>
  </dd>
  <dt><a href="#camel2Dash">camel2Dash(string)</a> ⇒ <code>String</code></dt>
  <dd><p>camel2Dash
  Преобразует строку в формате camelCase в строку с разделителями -, используя нижний регистр</p>
  </dd>
  <dt><a href="#clearAttr">clearAttr(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет все атрибуты HTML-тегов</p>
  </dd>
  <dt><a href="#clearBr">clearBr(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет переносы строк</p>
  </dd>
  <dt><a href="#clearHtml">clearHtml(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет HTML-теги</p>
  </dd>
  <dt><a href="#clearHtmlExpSN">clearHtmlExpSN(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет HTML-теги, сохраняя пробелы и переносы строк</p>
  </dd>
  <dt><a href="#clearHtmlN">clearHtmlN(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет HTML-теги и переносы строк</p>
  </dd>
  <dt><a href="#clearHtmlNS">clearHtmlNS(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет HTML-теги, пробелы и переносы строк</p>
  </dd>
  <dt><a href="#clearHtmlTag">clearHtmlTag(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Удаляет HTML-теги и текст внутри них</p>
  </dd>
  <dt><a href="#client">client(name, userAgent)</a> ⇒ <code>Object</code> | <code>Boolean</code></dt>
  <dd><p>Метод client возвращает результат определения браузера: { ANDROID: true, GECKO: true, GLSH_APP: false, IE: false, IOS: false, IPAD: false, IPHONE: false, MOBILE: true, MOBILEDEVICE: true, OPERA: false, QQ: false, QQBROWSER: false, TRIDENT: false, WEBKIT: true, WEIXIN: false }</p>
  </dd>
</dl>
``` <dt><a href="#cutCHSString">cutCHSString(str, len, hasDot)</a> ⇒ <code>String</code></dt>
  <dd><p>Обрезает строку, считая китайский символ за два символа.</p>
  </dd>
  <dt><a href="#dash2Camel">dash2Camel(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Преобразует строку с разделителями -, используя нижний регистр, в строку в формате camelCase.</p>
  </dd>
  <dt><a href="#deWxJumpLink">deWxJumpLink(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Заменяет <em> на =, ! на &amp; для декодирования в ссылку для перехода в WeChat.
  name</em>exMall-detail-goodsInfoId! params(goodsInfoId)*8866 преобразуется в name=exMall-detail-goodsInfoId&amp;params[goodsInfoId]=8866.</p>
  </dd>
  <dt><a href="#deWxJumpLinkOld">deWxJumpLinkOld(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Использует = для замены ~, использует &amp; для замены ^, декодирует в ссылку для перехода в WeChat.</p>
  </dd>
  <dt><a href="#debounce">debounce(fn, delay, immediate)</a> ⇒ <code>function</code></dt>
  <dd><p>Управление простоями, возвращает функцию, которая будет выполнена, если время простоя больше или равно задержке.</p>
  </dd>
  <dt><a href="#decodeBase64">decodeBase64(input)</a> ⇒ <code>String</code></dt>
  <dd><p>Декодирование Base64.</p>
  </dd>
  <dt><a href="#decodeUtf8">decodeUtf8(input)</a> ⇒ <code>String</code></dt>
  <dd><p>Декодирование UTF8.</p>
  </dd>
  <dt><a href="#delCookie">delCookie(name)</a></dt>
  <dd><p>Удаление cookie.</p>
  </dd>
  <dt><a href="#delLocal">delLocal(name)</a></dt>
  <dd><p>Удаление localStorage.</p>
  </dd>
  <dt><a href="#delSession">delSession(name)</a></dt>
  <dd><p>Удаление sessionStorage.</p>
  </dd>
  <dt><a href="#enWxJumpLink">enWxJumpLink(string)</a> ⇒ <code>String</code></dt>
  <dd><p>Использует <em> для замены =, использует ! для замены &amp;, кодирует в ссылку для перехода в WeChat.
  name=exMall-detail-goodsInfoId&amp;params[goodsInfoId]=8866 преобразуется в name</em>exMall-detail-goodsInfoId! params(goodsInfoId)*8866.</p>
  </dd><dt><a href="#enWxJumpLinkOld">enWxJumpLinkOld(string)</a> ⇒ <code>String</code></dt>
<dd><p>Используйте "~" для замены "=", используйте "^" для замены "&amp;", кодирование в ссылку для перехода в WeChat</p>
</dd>
<dt><a href="#encodeBase64">encodeBase64(input)</a> ⇒ <code>String</code></dt>
<dd><p>Кодирование строки или числа в Base64</p>
</dd>
<dt><a href="#encodeUtf8">encodeUtf8(input)</a> ⇒ <code>String</code></dt>
<dd><p>Кодирование UTF-8</p>
</dd>
<dt><a href="#formatTime">formatTime(time, fmt)</a> ⇒ <code>String</code></dt>
<dd><p>Плагин для форматирования даты
Способ использования: formatTime(new Date(), "yyyy-MM-dd")</p>
</dd>
<dt><a href="#formatTimeStr">formatTimeStr(time, fmt)</a> ⇒ <code>String</code></dt>
<dd><p>Форматирование времени в: "только что", "несколько минут назад"</p>
</dd>
<dt><a href="#getAppVersion">getAppVersion(appName, withosstr, userAgent)</a> ⇒ <code>Boolean</code> | <code>null</code></dt>
<dd><p>Получение версии приложения</p>
</dd>
<dt><a href="#getCHSLength">getCHSLength(str)</a> ⇒ <code>Number</code></dt>
<dd><p>Получение длины текста, китайский текст считается двумя байтами</p>
</dd>
<dt><a href="#getCookie">getCookie(name)</a> ⇒ <code>String</code></dt>
<dd><p>Чтение cookie</p>
</dd>
<dt><a href="#getDirParam">getDirParam(url)</a> ⇒ <code>Object</code></dt>
<dd><p>Получение параметров URL в виде каталога</p>
</dd>
<dt><a href="#getFileType">getFileType(url)</a> ⇒ <code>String</code></dt>
<dd><p>Файловое расширение</p>
</dd>
<dt><a href="#getIsAppVersionLastest">getIsAppVersionLastest(appName, compareVer, userAgent)</a> ⇒ <code>Boolean</code> | <code>null</code></dt>
<dd><p>Сравнение версий</p>
</dd>
<dt><a href="#getLocal">getLocal(name)</a> ⇒ <code>String</code></dt>
<dd><p>Чтение localStorage</p>
</dd>
<dt><a href="#getNumber">getNumber(string)</a> ⇒ <code>String</code></dt>
<dd><p>Получение чисел из строки</p>
</dd>
<dt><a href="#getOsVersion">getOsVersion(osName, withosstr, userAgent)</a> ⇒ <code>Boolean</code> | <code>null</code></dt>
<dd><p>Получение версии операционной системы</p>
</dd><dd><p>Получение версии операционной системы</p>
</dd>
<dt><a href="#getParameter">getParameter(name)</a> ⇒</dt>
<dd><p>Получение параметра URL</p>
</dd>
<dt><a href="#getRandomNum">getRandomNum(min, max)</a> ⇒ <code>Number</code></dt>
<dd><p>Получение случайного целого числа</p>
</dd>
<dt><a href="#getRandomStr">getRandomStr(len, widthSpecialChar)</a> ⇒ <code>String</code></dt>
<dd><p>Получение случайной строки</p>
</dd>
<dt><a href="#getRandomStrWidthSpecialChar">getRandomStrWidthSpecialChar(len)</a> ⇒ <code>String</code></dt>
<dd><p>Получение случайной строки с символами</p>
</dd>
<dt><a href="#getScrollPosition">getScrollPosition()</a> ⇒ <code>String</code></dt>
<dd><p>Получение положения прокрутки верхнего или нижнего края, возвращает &#39;top&#39; или &#39;bottom&#39;, рекомендуется использовать ограничение скорости</p>
</dd>
<dt><a href="#getSession">getSession(name)</a> ⇒ <code>String</code></dt>
<dd><p>Чтение sessionStorage</p>
</dd>
<dt><a href="#getUrlParam">getUrlParam(url)</a> ⇒ <code>Object</code></dt>
<dd><p>Получение параметров URL</p>
</dd>
<dt><a href="#getWindowSize">getWindowSize()</a> ⇒ <code>Object</code></dt>
<dd><p>Получение размера окна</p>
</dd>
<dt><a href="#imgAdapt">imgAdapt(imgurl, size)</a> ⇒ <code>String</code></dt>
<dd><p>Расширение изображения для автоматического соответствия разным разрешениям small original</p>
</dd>
<dt><a href="#imgChoose">imgChoose(imgurl)</a> ⇒ <code>String</code></dt>
<dd><p>Расширение изображения для автоматического соответствия разным разрешениям @2x @3x</p>
</dd>
<dt><a href="#isDigitals">isDigitals(str)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Является ли строка числом</p>
</dd>
<dt><a href="#isExitsFunction">isExitsFunction(funcName)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Существует ли указанный функционал</p>
</dd>
<dt><a href="#isExitsVariable">isExitsVariable(variableName)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Существует ли указанный переменной</p>
</dd><dd><p>Существует ли переменная, указанная в коде</p>
</dd><dt><a href="#pattern">pattern()</a> ⇒ <code>Object</code></dt>
<dd><p>pattern возвращает некоторые часто используемые регулярные выражения: any, arrjson, chinese, email, float, isjson, json, mobile, number, pass, postcode, qq, string, tel, textarea, url, username</p>
</dd>
<dt><a href="#removeEvent">removeEvent(element, type, handler)</a></dt>
<dd><p>removeEvent удаляет делегирование событий, созданное addEvent</p>
</dd>
<dt><a href="#setCookie">setCookie(name, value, seconds)</a></dt>
<dd><p>setCookie метод записи cookie</p>
</dd>
<dt><a href="#setLocal">setLocal(name, value, seconds)</a></dt>
<dd><p>запись в localStorage</p>
</dd>
<dt><a href="#setSession">setSession(name, value, seconds)</a></dt>
<dd><p>запись в sessionStorage</p>
</dd>
<dt><a href="#stopBubble">stopBubble(e)</a> ⇒ <code>Boolean</code></dt>
<dd><p>остановить всплытие</p>
</dd>
<dt><a href="#stopDefault">stopDefault(e)</a> ⇒ <code>Boolean</code></dt>
<dd><p>остановить действие по умолчанию для события</p>
</dd>
<dt><a href="#textareaInsertText">textareaInsertText(obj, str)</a></dt>
<dd><p>вставка текста в textarea или input объект в указанном положении курсора</p>
</dd>
<dt><a href="#textareaMoveToEnd">textareaMoveToEnd(obj)</a></dt>
<dd><p>перемещение курсора в конец текста в textarea или input объект</p>
</dd>
<dt><a href="#throttle">throttle(fn, delay, immediate)</a> ⇒ <code>function</code></dt>
<dd><p>ограничение частоты вызова функции fn, чтобы она выполнялась не чаще, чем каждые заданные миллисекунды</p>
</dd>
<dt><a href="#trim">trim(string, type)</a> ⇒ <code>String</code></dt>
<dd><p>trim() удаляет пробелы в зависимости от переданных параметров</p>
</dd><a name="addEvent"></a>## addEvent(element, type, handler)
Функция `addEvent()` для делегирования событий, поддерживает множественное делегирование.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| element | <code>Object</code> | объект js dom |
| type | <code>String</code> | тип события. Не нужно добавлять префикс `on` |
| handler | <code>function</code> | обратный вызов |

<a name="handleEvent"></a>

## handleEvent(event) ⇒ <code>Boolean</code>
Функция `handleEvent()` для выполнения события.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| event | <code>Object</code> | объект события |

<a name="fixEvent"></a>

## fixEvent(event) ⇒ <code>Object</code>
Добавляет недостающие методы к объекту события для Internet Explorer.

**Тип**: глобальная функция  
**Возвращает**: <code>Object</code> - объект события с добавленными методами  

| Параметр | Тип | Описание |
| --- | --- | --- |
| event | <code>Object</code> | объект события |

<a name="camel2Dash"></a>

## camel2Dash(string) ⇒ <code>String</code>
Функция `camel2Dash` преобразует строку в формате camelCase в формат с дефисами и строчными буквами.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - преобразованная строка  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка для преобразования |

<a name="clearAttr"></a>

## clearAttr(string) ⇒ <code>String</code>
Удаляет все атрибуты из HTML-тегов.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | входная строка |

<a name="clearBr"></a>

## clearBr(string) ⇒ <code>String</code>
Удаляет переносы строк.**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="clearHtml"></a>

## clearHtml(string) ⇒ <code>String</code>
Удаляет HTML-теги.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="clearHtmlExpSN"></a>

## clearHtmlExpSN(string) ⇒ <code>String</code>
Удаляет HTML-теги, но сохраняет пробелы и переносы строк.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="clearHtmlN"></a>

## clearHtmlN(string) ⇒ <code>String</code>
Удаляет HTML-теги и переносы строк.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="clearHtmlNS"></a>

## clearHtmlNS(string) ⇒ <code>String</code>
Удаляет HTML-теги и пробелы, переносы строк.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="clearHtmlTag"></a>

## clearHtmlTag(string) ⇒ <code>String</code>
Удаляет HTML-теги и текст внутри этих тегов.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | строка с HTML-тегами |

<a name="client"></a>

## client(name, userAgent) ⇒ <code>Объект</code> \| <code>Логическое значение</code>
Функция client возвращает результат определения браузера: { ANDROID: true, GECKO: true, GLSH_APP: false, IE: false, IOS: false, IPAD: false, IPHONE: false, MOBILE: true, MOBILEDEVICE: true, OPERA: false, QQ: false, QQBROWSER: false, TRIDENT: false, WEBKIT: true, WEIXIN: false }**Тип**: глобальная функция  
**Возвращает**: <code>Объект</code> \| <code>Логическое значение</code> - возвращает таблицу соответствия ua, если передано имя, то возвращает true/false, если соответствует этому терминалу  

| Параметр | Тип | Описание |
| --- | --- | --- |
| имя | <code>Строка</code> | опционально, например, передать "MicroMessenger", вернет, является ли это встроенным браузером WeChat |
| userAgent | <code>Строка</code> | опционально, передать пользовательский userAgent, по умолчанию берется из navigator.appVersion |

<a name="cutCHSString"></a>

## cutCHSString(строка, длина, естьТочка) ⇒ <code>Строка</code>
Обрезает строку, считая китайский символ за два символа

**Тип**: глобальная функция  
**Возвращает**: <code>Строка</code> - возвращает обрезанную строку  

| Параметр | Тип | Значение по умолчанию | Описание |
| --- | --- | --- | --- |
| строка | <code>Строка</code> |  | строка для обрезки |
| длина | <code>Число</code> |  |  |
| естьТочка | <code>Логическое значение</code> | <code>Ложь</code> |  |

<a name="dash2Camel"></a>

## dash2Camel(строка) ⇒ <code>Строка</code>
Преобразует строку в формате Dash (заголовок разделен дефисами и полностью малыми буквами) в формат CamelCase

**Тип**: глобальная функция  
**Возвращает**: <code>Строка</code> - возвращает преобразованную строку  

| Параметр | Тип | Описание |
| --- | --- | --- |
| строка | <code>Строка</code> | строка для преобразования |

<a name="deWxJumpLink"></a>

## deWxJumpLink(строка) ⇒ <code>Строка</code>
Заменяет символы: использует "=" вместо "*", а "&" вместо "!". Декодирует строку в ссылку для перехода в WeChat.**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат декодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка |

<a name="deWxJumpLinkOld"></a>

## deWxJumpLinkOld(string) ⇒ <code>String</code>
Заменяет символы: использует "=" вместо "~", а "&" вместо "^". Декодирует строку в ссылку для перехода в WeChat.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат декодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка |

<a name="debounce"></a>

## debounce(fn, delay, immediate) ⇒ <code>function</code>
Контроль простоя: если время простоя между вызовами функции больше или равно заданному, то функция будет выполнена.

**Тип**: глобальная функция  
**Возвращает**: <code>function</code> - фактический вызов функции  

| Параметр | Тип | Описание |
| --- | --- | --- |
| fn | <code>function</code> | Выполняемая функция |
| delay | <code>number</code> | Время простоя |
| immediate | <code>boolean</code> | Если передать false в качестве параметра immediate, то функция выполнится сразу, а не через заданный промежуток времени. |

<a name="decodeBase64"></a>

## decodeBase64(input) ⇒ <code>String</code>
Декодирует строку из формата Base64.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат декодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| input | <code>String</code> | Строка для декодирования |

<a name="decodeUtf8"></a>

## decodeUtf8(input) ⇒ <code>String</code>
Декодирует строку из формата UTF-8.**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат декодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| input | <code>String</code> | Строка для декодирования |

<a name="delCookie"></a>

## delCookie(name)
Удаляет cookie.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | Имя cookie |

<a name="delLocal"></a>

## delLocal(name)
Удаляет данные из localStorage.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | Имя |

<a name="delSession"></a>

## delSession(name)
Удаляет данные из sessionStorage.

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | Имя |

<a name="enWxJumpLink"></a>

## enWxJumpLink(string) ⇒ <code>String</code>
Заменяет = на *, а & на ! для преобразования в ссылку для перехода в WeChat.
Пример: name=exMall-detail-goodsInfoId&params[goodsInfoId]=8866 преобразуется в name*exMall-detail-goodsInfoId!params(goodsInfoId)*8866.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат преобразования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка |

<a name="enWxJumpLinkOld"></a>

## enWxJumpLinkOld(string) ⇒ <code>String</code>
Заменяет = на ~, а & на ^ для преобразования в ссылку для перехода в WeChat.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат преобразования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка |

<a name="encodeBase64"></a>

## encodeBase64(input) ⇒ <code>String</code>
Преобразование строки или числа в base64.**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат кодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| input | <code>String</code> | Строка для кодирования |

<a name="encodeUtf8"></a>

## encodeUtf8(input) ⇒ <code>String</code>
Кодирование в UTF-8

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат кодирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| input | <code>String</code> | Строка для кодирования |

<a name="formatTime"></a>

## formatTime(time, fmt) ⇒ <code>String</code>
Функция форматирования даты
Пример использования: formatTime(new Date(), "yyyy-MM-dd")

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат форматирования  

| Параметр | Тип | По умолчанию | Описание |
| --- | --- | --- | --- |
| time | <code>Date/String</code> |  | Объект даты или строка |
| fmt | <code>String</code> | <code>yyyy-MM-dd</code> | Формат |

<a name="formatTimeStr"></a>

## formatTimeStr(time, fmt) ⇒ <code>String</code>
Форматирование времени в "только что", "несколько минут назад"

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - результат форматирования  

| Параметр | Тип | Описание |
| --- | --- | --- |
| time | <code>Date/String</code> | Объект даты или строка |
| fmt | <code>String</code> | Формат |

<a name="getAppVersion"></a>

## getAppVersion(appName, withosstr, userAgent) ⇒ <code>Boolean</code> \| <code>null</code>
Получение версии приложения

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> \| <code>null</code> - null/true/false| Параметр | Тип | Описание |
| --- | --- | --- |
| appName | <code>String</code> | имя приложения |
| withosstr | <code>Boolean</code> | нужно ли включать имя операционной системы |
| userAgent | <code>String</code> | необязательный параметр, по умолчанию берется <code>navigator.appVersion</code> |<a name="getCHSLength"></a>

## getCHSLength(str) ⇒ <code>Number</code>
Получение длины текста, где китайский текст считается двумя байтами

**Тип**: глобальная функция  
**Возвращает**: <code>Number</code> - возвращает длину  

| Параметр | Тип | Описание |
| --- | --- | --- |
| str | <code>String</code> | строка |

<a name="getCookie"></a>

## getCookie(name) ⇒ <code>String</code>
Чтение cookies

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - возвращает строку cookie  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | имя cookie |

<a name="getDirParam"></a>

## getDirParam(url) ⇒ <code>Object</code>
Получение параметров URL в виде дерева

**Тип**: глобальная функция  
**Возвращает**: <code>Object</code> - возвращает объект параметров  

| Параметр | Тип | Описание |
| --- | --- | --- |
| url | <code>String</code> | переданный URL |

<a name="getFileType"></a>

## getFileType(url) ⇒ <code>String</code>
Расширение файла

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - возвращает расширение файла  

| Параметр | Тип | Описание |
| --- | --- | --- |
| url | <code>String</code> | имя файла |

<a name="getIsAppVersionLastest"></a>

## getIsAppVersionLastest(appName, compareVer, userAgent) ⇒ <code>Boolean</code> \| <code>null</code>
Сравнение версий

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> \| <code>null</code> - null/true/false  

| Параметр | Тип | Описание |
| --- | --- | --- |
| appName | <code>String</code> | имя приложения |
| compareVer | <code>String</code> | обязательный параметр, версия для сравнения |
| userAgent | <code>String</code> | ua, необязательный параметр, по умолчанию берется navigator.appVersion |<a name="getLocal"></a>

## getLocal(name) ⇒ <code>String</code>
Чтение данных из localStorage

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - возвращает строку из localStorage

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | Название |

<a name="getNumber"></a>

## getNumber(string) ⇒ <code>String</code>
Получить числа из строки

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - строку с чистыми числами

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка с числами |

<a name="getOsVersion"></a>

## getOsVersion(osName, withosstr, userAgent) ⇒ <code>Boolean</code> \| <code>null</code>
Получить версию мобильной операционной системы

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> \| <code>null</code> - null/true/false

| Параметр | Тип | Описание |
| --- | --- | --- |
| osName | <code>String</code> | Строка с типом системы: Android, iPod, iWatch или iPhone |
| withosstr | <code>Boolean</code> | Необходимо ли включать название системы |
| userAgent | <code>String</code> | ua, необязательный параметр, по умолчанию берется navigator.appVersion |

<a name="getParameter"></a>

## getParameter(name) ⇒
Получить отдельный параметр URL

**Тип**: глобальная функция  
**Возвращает**: значение параметра

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | Имя параметра |

<a name="getRandomNum"></a>

## getRandomNum(min, max) ⇒ <code>Number</code>
Получить случайное целое число

**Тип**: глобальная функция  
**Возвращает**: <code>Number</code> - число| Параметр | Тип | Значение по умолчанию | Описание |
| --- | --- | --- | --- |
| min | <code>Number</code> | <code>1</code> | Минимальное значение случайного числа |
| max | <code>Number</code> | <code>10</code> | Максимальное значение случайного числа |<a name="getRandomStr"></a>

## getRandomStr(len, widthSpecialChar) ⇒ <code>String</code>
Получить случайную строку

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - случайная строка  

| Параметр | Тип | Значение по умолчанию | Описание |
| --- | --- | --- | --- |
| len | <code>Number</code> | <code>32</code> | Длина случайной строки |
| widthSpecialChar | <code>Boolean</code> | <code>false</code> | Необязательный параметр, указывает, нужно ли включать специальные символы |

<a name="getRandomStrWidthSpecialChar"></a>

## getRandomStrWidthSpecialChar(len) ⇒ <code>String</code>
Получить случайную строку с специальными символами

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - случайная строка  

| Параметр | Тип | Значение по умолчанию | Описание |
| --- | --- | --- | --- |
| len | <code>Number</code> | <code>32</code> | Длина случайной строки |

<a name="getScrollPosition"></a>

## getScrollPosition() ⇒ <code>String</code>
Получает позицию прокрутки вверх или вниз. Возвращает 'top' или 'bottom'. Рекомендуется использовать с ограничением скорости.

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - позиция  

<a name="getSession"></a>

## getSession(name) ⇒ <code>String</code>
Чтение sessionStorage

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - значение sessionStorage  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | имя |

<a name="getUrlParam"></a>

## getUrlParam(url) ⇒ <code>Object</code>
Получение параметров URL

**Тип**: глобальная функция  
**Возвращает**: <code>Object</code> - параметры URL  

| Параметр | Тип | Описание |
| --- | --- | --- |
| url | <code>String</code> | URL параметра |<a name="getWindowSize"></a>

## getWindowSize() ⇒ <code>Object</code>
Получение размера окна

**Тип**: глобальная функция  
**Возвращает**: <code>Object</code> - размер окна  

<a name="imgAdapt"></a>

## imgAdapt(imgurl, size) ⇒ <code>String</code>
Расширение для автоматического подбора размера изображения small original

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - новый URL изображения  

| Параметр | Тип | Описание |
| --- | --- | --- |
| imgurl | <code>String</code> | URL изображения |
| size | <code>String</code> | размер изображения |

<a name="imgChoose"></a>

## imgChoose(imgurl) ⇒ <code>String</code>
Расширение для автоматического подбора размера изображения @2x @3x

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - новый URL изображения  

| Параметр | Тип | Описание |
| --- | --- | --- |
| imgurl | <code>String</code> | URL изображения |

<a name="isDigitals"></a>

## isDigitals(str) ⇒ <code>Boolean</code>
Проверка, является ли строка числом

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> - true/false  

| Параметр | Тип | Описание |
| --- | --- | --- |
| str | <code>String</code> | строка для проверки |

<a name="isExitsFunction"></a>

## isExitsFunction(funcName) ⇒ <code>Boolean</code>
Проверка наличия функции

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> - true/false  

| Параметр | Тип | Описание |
| --- | --- | --- |
| funcName | <code>String</code> | имя функции |

<a name="isExitsVariable"></a>

## isExitsVariable(variableName) ⇒ <code>Boolean</code>
Проверка наличия переменной

**Тип**: глобальная функция  
**Возвращает**: <code>Boolean</code> - true/false| Параметр | Тип | Описание |
| --- | --- | --- |
| variableName | <code>String</code> | передает имя переменной |

<a name="pattern"></a>

## pattern() ⇒ <code>Object</code>
pattern возвращает некоторые часто используемые регулярные выражения: any, arrjson, chinese, email, float, isjson, json, mobile, number, pass, postcode, qq, string, tel, textarea, url, username

**Тип**: глобальная функция  
**Возвращает**: <code>Object</code> - возвращает объект  
<a name="removeEvent"></a>

## removeEvent(element, type, handler)
removeEvent удаляет события, созданные с помощью addEvent

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| element | <code>Object</code> | объект js dom |
| type | <code>String</code> | тип события. Не нужно добавлять "on" |
| handler | <code>function</code> | обратный вызов |

<a name="setCookie"></a>

## setCookie(name, value, seconds)
setCookie метод записи cookie

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | имя cookie |
| value | <code>\*</code> | устанавливает значение для хранения, может быть объектом или строкой |
| seconds | <code>Number</code> | срок действия cookie |

<a name="setLocal"></a>

## setLocal(name, value, seconds)
запись localStorage

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | имя |
| value | <code>\*</code> | устанавливает значение для хранения, может быть объектом или строкой |
| seconds | <code>Number</code> | срок действия |

<a name="setSession"></a>

## setSession(name, value, seconds)
запись sessionStorage

**Тип**: глобальная функция| Параметр | Тип | Описание |
| --- | --- | --- |
| name | <code>String</code> | имя |
| value | <code>\*</code> | устанавливает значение для хранения, может быть объектом или строкой |
| seconds | <code>Number</code> | срок действия |<a name="stopBubble"></a>

## stopBubble(e) ⇒ <code>Boolean</code>
остановить всплытие события

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| e | <code>Object</code> | объект события DOM |

<a name="stopDefault"></a>

## stopDefault(e) ⇒ <code>Boolean</code>
остановить стандартное действие

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| e | <code>Object</code> | объект события DOM |

<a name="textareaInsertText"></a>

## textareaInsertText(obj, str)
Вставляет текст в textarea или input объект в указанной позиции курсора

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| obj | <code>Object</code> | DOM объект |
| str | <code>String</code> | Вставляемый текст |

<a name="textareaMoveToEnd"></a>

## textareaMoveToEnd(obj)
Перемещает курсор в textarea или input объект к концу текста

**Тип**: глобальная функция  

| Параметр | Тип | Описание |
| --- | --- | --- |
| obj | <code>Object</code> | DOM объект |

<a name="throttle"></a>

## throttle(fn, delay, immediate) ⇒ <code>function</code>
Ограничение частоты вызова функции. Возвращает функцию, которая будет вызвана не чаще, чем каждые заданные миллисекунды.

**Тип**: глобальная функция  
**Возвращает**: <code>function</code> - фактический вызов функции  

| Параметр | Тип | Описание |
| --- | --- | --- |
| fn | <code>function</code> | Вызываемая функция |
| delay | <code>number</code> | Задержка времени, миллисекунды |
| immediate | <code>bool</code> | Передайте false в качестве параметра immediate, чтобы функция была вызвана сразу, а не через задержку. |

<a name="trim"></a>## trim(string, type) ⇒ <code>String</code>
trim() удаляет пробелы в зависимости от переданных параметров

**Тип**: глобальная функция  
**Возвращает**: <code>String</code> - возвращает новую строку  

| Параметр | Тип | Описание |
| --- | --- | --- |
| string | <code>String</code> | Входная строка |
| type | <code>string</code> | Опционально, тип удаления пробелов: l - удаление пробелов в начале, r - удаление пробелов в конце, lr - удаление пробелов с обоих концов, пустое значение - удаление всех пробелов |

### Участие в проекте

1. Fork этого репозитория
2. Создайте новую ветку Feat_xxx
3. Подайте Pull Request

### Мои проекты

- ***Используйте*** _Readme_XXX.md_ для поддержки различных языков, `например` _Readme_en.md, Readme_zh.md_
- Мой репозиторий на Gitee: [https://gitee.com/saqqdy](https://gitee.com/saqqdy)
- Мой репозиторий на GitHub: [https://github.com/saqqdy](https://github.com/saqqdy)
- Мой npm: [https://npmjs.com/~saqqdy](https://npmjs.com/~saqqdy)
- Мой личный сайт: [http://www.saqqdy.com](http://www.saqqdy.com)