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