js doofinder

Библиотека Дофиндера

Эта библиотека, известная как js-doofinder или просто doofinder , позволяет легко выполнять запросы к службе поиска Doofinder и настраивать способ представления результатов.

• Установка
  • Пряжа
  • НПМ
  • CDN
• ТЛ;ДР
• Быстрый старт
• Документация

Установка

Библиотеку можно установить через менеджеры пакетов или напрямую указав файл в CDN jsDelivr.

Yarnpkg (рекомендуется)

$ yarn add doofinder

НПМ

$ npm install doofinder

ЭСМ

 import { Client } from 'doofinder' ; 

CommonJS

 const { Client } = require ( 'doofinder/commonjs' ) ;

CDN

Вы можете включить библиотеку прямо на свой сайт:

 <!-- Javascript -->
< script src =" //cdn.jsdelivr.net/npm/doofinder@latest/dist/doofinder.min.js " > </ script > 

ТЛ;ДР

Если вы хотите знать только, как это структурировано, без подробностей, вот и все.

Библиотека предоставляет:

• Client класс для выполнения запросов к службе Doofinder.
• Класс Query , который предоставляет простой в использовании объект для подготовки запросов к Client Doofinder перед отправкой чего-либо.
• Класс Result для переноса ответа от сервера и доступа к данным с помощью простых в использовании методов.
• Синглтон ClientRepo , который содержит пул Client Doofinder в каждой зоне и помогает создавать их экземпляры.

Быстрый старт

Проект включает демо-версию, которую вы можете использовать в качестве вдохновения. Чтобы посмотреть и увидеть, что вы можете с ним сделать:

1. Загрузите весь проект с Github.
2. Убедитесь, что в вашей системе работает Node 10.x.
3. Из корня проекта:
   1. установите зависимости с помощью $ yarn install или $ npm install .
4. Чтобы запустить тесты, выполните: $ yarn test .

Демо-разметка находится внутри index.html , а соответствующий код Javascript можно найти по адресу playground/demo.js .

ВНИМАНИЕ. В демо-версии используется тестовая поисковая система, но вы можете использовать другую, просто измените значение переменной HASHID которую вы найдете внутри index.html .

ВАЖНО: Doofinder защищает вызовы API с помощью CORS. Если вы измените переменную HASHID , определенную в index.html вам придется разрешить localhost для вашей поисковой системы в администраторе Doofinder.

Как пользоваться библиотекой

Чтобы ознакомиться с использованием этого проекта, вы можете воспользоваться примерами, представленными на игровой площадке.

Ключевым компонентом является файл demo.js, но для его эффективного использования вам необходимо понимать следующие параметры:

1. сервер: https://docs.doofinder.com/api/search/v6/#section/Basics/Endpoint
2. секрет: https://docs.doofinder.com/api/search/v6/#section/Basics/Authentication
3. хешид: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions
4. идентификатор сеанса: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions

Документация

ВАЖНО: Эта работа находится в стадии разработки.

https://doofinder.github.io/js-doofinder/

Поддержка браузера

Браузер	Автономный	Модуль ES
Край	15+	16+
Firefox	32+	60+
Хром	55+	61+
Сафари	11+	11+
Опера	42+	48+
Хром для Android	76+	76+
Firefox для Android	68+	68+
UC-браузер для Android	12.12+	12.12+
Сафари для iOS	11+	11+