JavaScript реализация HTTP API Главреда (glvrd.ru)
Эта библиотека упрощает работу с HTTP API (v2) Главреда. Библиотека может работать как в браузере, так и на Ноде.
Подключение
Браузер
-
Скачиваем и подключаем на страницу скрипт
lib/glvrd.js
: -
В своих скриптах теперь доступен глобальный объект Glavred, который можно использовать так:
var glvrd = "Joomla plugin v1.2";var text = "Несоменно очень важный текст.";glvrd;
Node.js/Element
-
Включаем пакет
glvrd-http-api
в свой проект.npm install --save glvrd-http-api
-
Теперь можно включить АПИ Главреда с помощью require:
var Glavred = ;var glvrd = "Element plugin v5.0";var text = "Несоменно очень важный текст.";glvrd;
Реализация
Библиотека сама обеспечивает регистрацию и поддержку сессий связи с сервисом главреда. Таким образом, всё что вам потребуется это два метода:
-
Конструктор
new Glavred("Your app name")
: возвращает рабочий экземпляр библиотеки. Каждый экземпляр будет вести собственную сессию связи с главредом.Вы всегда должны передавать название своего приложения в конструкторе.
-
Метод
proofread("Some text")
: принимает строку для проверки, отдаёт объект Promise, который обещает выполнить коллбек с аргументом вида:Этот метод принимает второй параметр, через который вы можете запретить автоматическую подгрузку
hints
иscore
в результатах проверки.
Дополнительные методы
-
getScore(proofreadResults)
: Позволяет синхронно рассчитать общую оценку качества текста для одного или нескольких результатов проверки. -
getHints(ids)
: Принимает массив идентификаторов описаний проблем с текстом. Отдаёт объектPromise
, который обещает выполнить коллбек с таким аргументом: -
Остальные методы документированы в коде библиотеки (см. файл src/glvrd.js).