1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/saqqdy-common

Клонировать/Скачать
API.md 41 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 06.06.2025 03:52 9e22b9e

Функции

addEvent(element, type, handler)

addEvent() — событие делегирования, поддерживает множественное делегирование

handleEvent(event)Boolean

handleEvent() — выполнение события

fixEvent(event)Object

Добавляет некоторые "отсутствующие" функции объекту события для IE

camel2Dash(string)String

camel2Dash Преобразует строку в формате camelCase в строку с разделителями -, используя нижний регистр

clearAttr(string)String

Удаляет все атрибуты HTML-тегов

clearBr(string)String

Удаляет переносы строк

clearHtml(string)String

Удаляет HTML-теги

clearHtmlExpSN(string)String

Удаляет HTML-теги, сохраняя пробелы и переносы строк

clearHtmlN(string)String

Удаляет HTML-теги и переносы строк

clearHtmlNS(string)String

Удаляет HTML-теги, пробелы и переносы строк

clearHtmlTag(string)String

Удаляет HTML-теги и текст внутри них

client(name, userAgent)Object | Boolean

Метод 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 }

cutCHSString(str, len, hasDot)String

Обрезает строку, считая китайский символ за два символа.

dash2Camel(string)String

Преобразует строку с разделителями -, используя нижний регистр, в строку в формате camelCase.

deWxJumpLink(string)String

Заменяет на =, ! на & для декодирования в ссылку для перехода в WeChat. nameexMall-detail-goodsInfoId! params(goodsInfoId)*8866 преобразуется в name=exMall-detail-goodsInfoId&params[goodsInfoId]=8866.

deWxJumpLinkOld(string)String

Использует = для замены ~, использует & для замены ^, декодирует в ссылку для перехода в WeChat.

debounce(fn, delay, immediate)function

Управление простоями, возвращает функцию, которая будет выполнена, если время простоя больше или равно задержке.

decodeBase64(input)String

Декодирование Base64.

decodeUtf8(input)String

Декодирование UTF8.

delCookie(name)

Удаление cookie.

delLocal(name)

Удаление localStorage.

delSession(name)

Удаление sessionStorage.

enWxJumpLink(string)String

Использует для замены =, использует ! для замены &, кодирует в ссылку для перехода в WeChat. name=exMall-detail-goodsInfoId&params[goodsInfoId]=8866 преобразуется в nameexMall-detail-goodsInfoId! params(goodsInfoId)*8866.

enWxJumpLinkOld(string)String

Используйте "~" для замены "=", используйте "^" для замены "&", кодирование в ссылку для перехода в WeChat

encodeBase64(input)String

Кодирование строки или числа в Base64

encodeUtf8(input)String

Кодирование UTF-8

formatTime(time, fmt)String

Плагин для форматирования даты Способ использования: formatTime(new Date(), "yyyy-MM-dd")

formatTimeStr(time, fmt)String

Форматирование времени в: "только что", "несколько минут назад"

getAppVersion(appName, withosstr, userAgent)Boolean | null

Получение версии приложения

getCHSLength(str)Number

Получение длины текста, китайский текст считается двумя байтами

getCookie(name)String

Чтение cookie

getDirParam(url)Object

Получение параметров URL в виде каталога

getFileType(url)String

Файловое расширение

getIsAppVersionLastest(appName, compareVer, userAgent)Boolean | null

Сравнение версий

getLocal(name)String

Чтение localStorage

getNumber(string)String

Получение чисел из строки

getOsVersion(osName, withosstr, userAgent)Boolean | null

Получение версии операционной системы

Получение версии операционной системы

getParameter(name)

Получение параметра URL

getRandomNum(min, max)Number

Получение случайного целого числа

getRandomStr(len, widthSpecialChar)String

Получение случайной строки

getRandomStrWidthSpecialChar(len)String

Получение случайной строки с символами

getScrollPosition()String

Получение положения прокрутки верхнего или нижнего края, возвращает 'top' или 'bottom', рекомендуется использовать ограничение скорости

getSession(name)String

Чтение sessionStorage

getUrlParam(url)Object

Получение параметров URL

getWindowSize()Object

Получение размера окна

imgAdapt(imgurl, size)String

Расширение изображения для автоматического соответствия разным разрешениям small original

imgChoose(imgurl)String

Расширение изображения для автоматического соответствия разным разрешениям @2x @3x

isDigitals(str)Boolean

Является ли строка числом

isExitsFunction(funcName)Boolean

Существует ли указанный функционал

isExitsVariable(variableName)Boolean

Существует ли указанный переменной

Существует ли переменная, указанная в коде

pattern()Object

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

removeEvent(element, type, handler)

removeEvent удаляет делегирование событий, созданное addEvent

setCookie(name, value, seconds)

setCookie метод записи cookie

setLocal(name, value, seconds)

запись в localStorage

setSession(name, value, seconds)

запись в sessionStorage

stopBubble(e)Boolean

остановить всплытие

stopDefault(e)Boolean

остановить действие по умолчанию для события

textareaInsertText(obj, str)

вставка текста в textarea или input объект в указанном положении курсора

textareaMoveToEnd(obj)

перемещение курсора в конец текста в textarea или input объект

throttle(fn, delay, immediate)function

ограничение частоты вызова функции fn, чтобы она выполнялась не чаще, чем через определенное количество времени

trim(string, type)String

trim() удаляет пробелы в зависимости от переданных параметров

## addEvent(element, type, handler) Функция `addEvent()` для делегирования событий, поддерживает множественное делегирование.

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

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

handleEvent(event) ⇒ Boolean

Функция handleEvent() для выполнения события.

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

Параметр Тип Описание
event Object объект события

fixEvent(event) ⇒ Object

Добавляет недостающие методы к объекту события для Internet Explorer.

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

Параметр Тип Описание
event Object объект события

camel2Dash(string) ⇒ String

Функция camel2Dash преобразует строку в формате camelCase в формат с дефисами и строчными буквами.

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

Параметр Тип Описание
string String строка для преобразования

clearAttr(string) ⇒ String

Удаляет все атрибуты из HTML-тегов.

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

Параметр Тип Описание
string String входная строка

clearBr(string) ⇒ String

Удаляет переносы строк.Тип: глобальная функция

Параметр Тип Описание
string String строка с HTML-тегами

clearHtml(string) ⇒ String

Удаляет HTML-теги.

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

Параметр Тип Описание
string String строка с HTML-тегами

clearHtmlExpSN(string) ⇒ String

Удаляет HTML-теги, но сохраняет пробелы и переносы строк.

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

Параметр Тип Описание
string String строка с HTML-тегами

clearHtmlN(string) ⇒ String

Удаляет HTML-теги и переносы строк.

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

Параметр Тип Описание
string String строка с HTML-тегами

clearHtmlNS(string) ⇒ String

Удаляет HTML-теги и пробелы, переносы строк.

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

Параметр Тип Описание
string String строка с HTML-тегами

clearHtmlTag(string) ⇒ String

Удаляет HTML-теги и текст внутри этих тегов.

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

Параметр Тип Описание
string String строка с HTML-тегами

client(name, userAgent) ⇒ Объект | Логическое значение

Функция 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 }Тип: глобальная функция
Возвращает: Объект | Логическое значение - возвращает таблицу соответствия ua, если передано имя, то возвращает true/false, если соответствует этому терминалу

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

cutCHSString(строка, длина, естьТочка) ⇒ Строка

Обрезает строку, считая китайский символ за два символа

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

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

dash2Camel(строка) ⇒ Строка

Преобразует строку в формате Dash (заголовок разделен дефисами и полностью малыми буквами) в формат CamelCase

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

Параметр Тип Описание
строка Строка строка для преобразования

deWxJumpLink(строка) ⇒ Строка

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

Параметр Тип Описание
string String Входная строка

deWxJumpLinkOld(string) ⇒ String

Заменяет символы: использует "=" вместо "~", а "&" вместо "^". Декодирует строку в ссылку для перехода в WeChat.

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

Параметр Тип Описание
string String Входная строка

debounce(fn, delay, immediate) ⇒ function

Контроль простоя: если время простоя между вызовами функции больше или равно заданному, то функция будет выполнена.

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

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

decodeBase64(input) ⇒ String

Декодирует строку из формата Base64.

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

Параметр Тип Описание
input String Строка для декодирования

decodeUtf8(input) ⇒ String

Декодирует строку из формата UTF-8.Тип: глобальная функция
Возвращает: String - результат декодирования

Параметр Тип Описание
input String Строка для декодирования

delCookie(name)

Удаляет cookie.

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

Параметр Тип Описание
name String Имя cookie

delLocal(name)

Удаляет данные из localStorage.

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

Параметр Тип Описание
name String Имя

delSession(name)

Удаляет данные из sessionStorage.

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

Параметр Тип Описание
name String Имя

enWxJumpLink(string) ⇒ String

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

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

Параметр Тип Описание
string String Входная строка

enWxJumpLinkOld(string) ⇒ String

Заменяет = на ~, а & на ^ для преобразования в ссылку для перехода в WeChat.

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

Параметр Тип Описание
string String Входная строка

encodeBase64(input) ⇒ String

Преобразование строки или числа в base64.Тип: глобальная функция
Возвращает: String - результат кодирования

Параметр Тип Описание
input String Строка для кодирования

encodeUtf8(input) ⇒ String

Кодирование в UTF-8

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

Параметр Тип Описание
input String Строка для кодирования

formatTime(time, fmt) ⇒ String

Функция форматирования даты Пример использования: formatTime(new Date(), "yyyy-MM-dd")

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

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

formatTimeStr(time, fmt) ⇒ String

Форматирование времени в "только что", "несколько минут назад"

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

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

getAppVersion(appName, withosstr, userAgent) ⇒ Boolean | null

Получение версии приложения

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

getCHSLength(str) ⇒ Number

Получение длины текста, где китайский текст считается двумя байтами

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

Параметр Тип Описание
str String строка

getCookie(name) ⇒ String

Чтение cookies

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

Параметр Тип Описание
name String имя cookie

getDirParam(url) ⇒ Object

Получение параметров URL в виде дерева

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

Параметр Тип Описание
url String переданный URL

getFileType(url) ⇒ String

Расширение файла

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

Параметр Тип Описание
url String имя файла

getIsAppVersionLastest(appName, compareVer, userAgent) ⇒ Boolean | null

Сравнение версий

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

Параметр Тип Описание
appName String имя приложения
compareVer String обязательный параметр, версия для сравнения
userAgent String ua, необязательный параметр, по умолчанию берется navigator.appVersion

getLocal(name) ⇒ String

Чтение данных из localStorage

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

Параметр Тип Описание
name String Название

getNumber(string) ⇒ String

Получить числа из строки

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

Параметр Тип Описание
string String Входная строка с числами

getOsVersion(osName, withosstr, userAgent) ⇒ Boolean | null

Получить версию мобильной операционной системы

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

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

getParameter(name) ⇒

Получить отдельный параметр URL

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

Параметр Тип Описание
name String Имя параметра

getRandomNum(min, max) ⇒ Number

Получить случайное целое число

Тип: глобальная функция
Возвращает: Number - число| Параметр | Тип | Значение по умолчанию | Описание | | --- | --- | --- | --- | | min | Number | 1 | Минимальное значение случайного числа | | max | Number | 10 | Максимальное значение случайного числа |

getRandomStr(len, widthSpecialChar) ⇒ String

Получить случайную строку

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

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

getRandomStrWidthSpecialChar(len) ⇒ String

Получить случайную строку с специальными символами

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

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

getScrollPosition() ⇒ String

Получает позицию прокрутки вверх или вниз. Возвращает 'top' или 'bottom'. Рекомендуется использовать с ограничением скорости.

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

getSession(name) ⇒ String

Чтение sessionStorage

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

Параметр Тип Описание
name String имя

getUrlParam(url) ⇒ Object

Получение параметров URL

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

Параметр Тип Описание
url String URL

getWindowSize() ⇒ Object

Получение размера окна

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

imgAdapt(imgurl, size) ⇒ String

Расширение для автоматического изменения размера изображений для различных разрешений small original

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

Параметр Тип Описание
imgurl String URL изображения
size String размер изображения

imgChoose(imgurl) ⇒ String

Расширение для автоматического изменения размера изображений для различных разрешений @2x @3x

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

Параметр Тип Описание
imgurl String URL изображения

isDigitals(str) ⇒ Boolean

Проверка, является ли строка числом

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

Параметр Тип Описание
str String строка для проверки

isExitsFunction(funcName) ⇒ Boolean

Проверка наличия функции

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

Параметр Тип Описание
funcName String имя функции

isExitsVariable(variableName) ⇒ Boolean

Проверка наличия переменной

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

pattern() ⇒ Object

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

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

removeEvent(element, type, handler)

removeEvent удаляет события, созданные с помощью addEvent

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

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

setCookie(name, value, seconds)

setCookie метод записи cookie

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

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

setLocal(name, value, seconds)

запись localStorage

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

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

setSession(name, value, seconds)

запись sessionStorage

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

stopBubble(e) ⇒ Boolean

Остановить всплытие

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

Параметр Тип Описание
e Object объект события dom

stopDefault(e) ⇒ Boolean

Остановить стандартное действие

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

Параметр Тип Описание
e Object объект события dom

textareaInsertText(obj, str)

Вставляет текст в указанное положение курсора для объекта textarea или input

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

Параметр Тип Описание
obj Object DOM-объект
str String Текст для вставки

textareaMoveToEnd(obj)

Перемещает курсор в конец текста для объекта textarea или input

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

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

throttle(fn, delay, immediate) ⇒ function

Ограничивает частоту вызова функции. Возвращает функцию, которая будет вызвана не чаще, чем раз в заданный промежуток времени.

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

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

trim(string, type) ⇒ String

Удаляет пробелы из строки в зависимости от переданного параметра

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

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

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/saqqdy-common.git
git@api.gitlife.ru:oschina-mirror/saqqdy-common.git
oschina-mirror
saqqdy-common
saqqdy-common
master