typesense js
v1.8.2
Biblioteca cliente Javascript para acceder a la API HTTP de Typesense.
Esta biblioteca se puede utilizar tanto en el lado del servidor como en el del cliente. El código fuente de la biblioteca está en ES6 y durante el tiempo de compilación, lo transpilamos a ES5 y generamos dos artefactos: uno que se puede usar en el lado del servidor y otro que usa Browserify y se puede usar en el lado del cliente.
npm install --save typesenseInstalar dependencias de pares:
npm install --save @babel/runtime Nota: @babel/runtime es una dependencia muy común entre muchas bibliotecas JS. Entonces, en lugar de que cada biblioteca lo agregue como una dependencia de forma independiente (lo que provocará que se instalen múltiples instancias de @babel/runtime aumentando el tamaño del paquete), la recomendación de Babel es que las bibliotecas soliciten a los usuarios que lo instalen una vez como una dependencia directa, por lo que solo hay una copia de @babel/runtime para todo el proyecto. En algunos casos, es posible que su marco JS ya incluya @babel/runtime como dependencia.
< script src =" dist/typesense.min.js " > </ script >o vía jsDelivr
< script src =" https://cdn.jsdelivr.net/npm/typesense@1/dist/typesense.min.js " > </ script > Lea la documentación aquí para ver ejemplos detallados: https://typesense.org/docs/api/
Las pruebas también son un buen lugar para saber cómo funciona internamente la biblioteca: prueba
Nota: Cuando utilice esta biblioteca en un navegador, asegúrese de utilizar una clave API que solo permita operaciones de búsqueda en lugar de la clave API master . Consulte doc/examples/server/keys.js para ver un ejemplo de cómo generar una clave API de solo búsqueda.
Consulte Configuration.ts para obtener una lista de todas las opciones de configuración del cliente.
A continuación se muestran algunos ejemplos con comentarios en línea que le guiarán en el uso del cliente: doc/examples
Para ejecutar los ejemplos, desde la raíz del repositorio:
npm run typesenseServer
node doc/examples/server/bulkImport.jsSi usa GatsbyJS como marco, tenemos un complemento (que usa Typesense-js detrás de escena) para enviar automáticamente los datos de su sitio a Typesense cuando crea su sitio. Obtenga más información aquí.
Si usa Firebase, tenemos una extensión de Firebase (que usa Typesense-js detrás de escena) para enviar automáticamente sus datos de Firestore a Typesense. Obtenga más información aquí.
Consulte Typesense-InstantSearch.js (que utiliza Typesense-js) para conocer los componentes de la interfaz de usuario que puede utilizar para crear rápidamente potentes experiencias de búsqueda instantánea.
Esta tabla hace referencia a la compatibilidad del servidor=>cliente. Las versiones más nuevas de la biblioteca del cliente mantienen la compatibilidad con versiones anteriores de la biblioteca del servidor.
| Servidor Typesense | tipos-js |
|---|---|
| >= v27.0.rc20 | >= v2.0.0 |
| >= v0.26.0.rc38 | >= v1.8.0 |
| >= v0.25.0 | >= v1.7.0 |
| >= v0.24.0 | >= v1.5.0 |
| >= v0.23.0 | >= v1.3.0 |
| >= v0.21.0 | >= v0.14.0 |
| >= v0.20.0 | >= v0.12.0 |
| >= v0.19.0 | >= v0.11.0 |
| >= v0.18.0 | >= v0.10.0 |
| >= v0.17.0 | >= v0.9.0 |
| >= v0.16.0 | >= v0.8.0 |
| >= v0.15.0 | >= v0.7.0 |
| >= v0.12.1 | >= v0.5.0 |
| >= v0.12.0 | >= v0.4.7 |
| <= v0.11 | <= v0.3.0 |
Después de consultar el repositorio, ejecute npm install para instalar las dependencias. Luego ejecute npm test para ejecutar linter y las pruebas.
Para lanzar una nueva versión, usamos el paquete np:
$ npm install --global np
$ np
# Follow instructions that np shows you
Los informes de errores y las solicitudes de extracción son bienvenidos en GitHub en https://github.com/typesense/typesense-js.
