js doofinder

Biblioteca Doofinder

También conocida como js-doofinder , o simplemente doofinder , esta biblioteca facilita la realización de solicitudes al servicio de búsqueda de Doofinder y personaliza la forma en que presenta los resultados.

• Instalación
  • Paquete de hilo
  • MNP
  • CDN
• TL;DR
• Inicio rápido
• Documentación

Instalación

La biblioteca se puede instalar a través de administradores de paquetes o apuntando directamente a un archivo en el CDN de jsDelivr.

Paquete de hilo (recomendado)

$ yarn add doofinder

MNP

$ npm install doofinder

MEDE

 import { Client } from 'doofinder' ; 

JS común

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

CDN

Puedes incluir la biblioteca directamente en tu sitio web:

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

TL;DR

Si sólo quieres saber cómo está estructurado esto, sin los detalles, allá vamos.

La biblioteca ofrece:

• Una clase Client para realizar solicitudes al servicio Doofinder.
• Una clase Query que proporciona un objeto fácil de usar para preparar las consultas al Client Doofinder antes de enviar cualquier cosa.
• Una clase Result para empaquetar la respuesta del servidor y acceder a los datos a través de métodos fáciles de usar.
• Un singleton ClientRepo que contiene un grupo de Client Doofinder en cada zona y ayuda a crear instancias de ellos.

Inicio rápido

El proyecto incluye una demostración que puedes utilizar como inspiración. Para echarle un vistazo y ver qué puedes hacer con él:

1. Descarga el proyecto completo desde Github.
2. Asegúrese de tener Nodo 10.x ejecutándose en su sistema.
3. Desde la raíz del proyecto:
   1. Instale dependencias con $ yarn install o $ npm install .
4. Para ejecutar las pruebas, ejecute: $ yarn test .

El marcado de demostración se encuentra dentro de index.html y el código Javascript relacionado se puede encontrar en playground/demo.js .

AVISO: La demostración utiliza un motor de búsqueda de prueba pero puedes usar uno diferente, simplemente cambia el valor de la variable HASHID que encontrarás dentro de index.html .

IMPORTANTE: Doofinder protege las llamadas API con CORS. Si cambia la variable HASHID definida en index.html deberá permitir localhost para su motor de búsqueda en Doofinder Admin.

Cómo utilizar la biblioteca

Para familiarizarse con el uso de este proyecto, puede seguir los ejemplos proporcionados en el patio de juegos.

El componente clave es el archivo demo.js, pero para utilizarlo de forma eficaz, deberá comprender los siguientes parámetros:

1. servidor: https://docs.doofinder.com/api/search/v6/#section/Basics/Endpoint
2. secreto: https://docs.doofinder.com/api/search/v6/#section/Basics/Authentication
3. hashid: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions
4. ID de sesión: https://docs.doofinder.com/api/search/v6/#section/Basics/Conventions

Documentación

IMPORTANTE: Este es un trabajo en progreso.

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

Soporte del navegador

Navegador	Autónomo	Módulo ES
Borde	15+	16+
Firefox	32+	60+
Cromo	55+	61+
Safari	11+	11+
Ópera	42+	48+
Chrome para Android	76+	76+
Firefox para Android	68+	68+
Navegador UC para Android	12.12+	12.12+
Safari para iOS	11+	11+