Пакет выполняет функцию менеджера для абстракции - "действий пользователя", со стороны клиента. Немного упрощает организацию запросов к серверу и обработки ответов от него.
ПРЕДУПРЕЖДЕНИЕ: Пакет представляет собой web-библиотеку. Предназначен для использования в браузерах (использует переменную окружения window).
С использованием систем сборки
- Добавить пакет в проект -
npm i uam-client
- Подключить к проекту (в главный файл js) -
require("swipe_detector")
- Можно обращаться в коде проекта через -
window.NG.UAM
Как библиотеку
- Клонировать проект с GitHub и перейти в папку -
git clone git@github.com:Nonagod/uam-client.git
- Установить зависимости -
npm i
- Собрать проект -
gulp
- Копировать код библиотеки из -
./build/libs.min.js
Отправляет запрос на сервер (для отправки использует метод fetch
). В качестве параметра, принимает объект
настроек следующего содержания:
data
- обязательный, объект данных запроса. Можно передавать в форматеFormData
.
ВАЖНО: Обязательно должен содержать ключ
user_action
со строковым значением.
handlers
- объект содержащий функции обработчики результатов запросаsuccess
- функция-обработчик успешного выполнения. На вход получает один параметр содержащий результаты запроса.error
- функция-обработчик неудачного выполнения запроса. На вход получает объект ошибкиUAMError
(значимые свойстваe.info
- данные ошибки,e.SystemError
- системная ошибка).
url
- адрес на который сделать запрос (по умол. текущая страница)emulation
- функция эмуляции запроса, на вход принимает объект опций. должна возвращать объект согласно абстракции
[] Ошибки в обработчиках не должны вызываться как системная от UAM