typesense js
v1.8.2
Biblioteca cliente Javascript para acessar a API HTTP Typesense.
Esta biblioteca pode ser usada tanto no lado do servidor quanto no lado do cliente. A fonte da biblioteca está em ES6 e durante o build, nós a transpilamos para ES5 e geramos dois artefatos - um que pode ser usado no lado do servidor e outro que usa o Browserify e pode ser usado no lado do cliente.
npm install --save typesenseInstale dependências de pares:
npm install --save @babel/runtime Nota: @babel/runtime é uma dependência muito comum entre muitas bibliotecas JS. Portanto, em vez de cada biblioteca adicioná-lo como uma dependência de forma independente (o que fará com que várias instâncias de @babel/runtime sejam instaladas, aumentando o tamanho do pacote), a recomendação de Babel é que as bibliotecas solicitem aos usuários que o instalem uma vez como uma dependência direta, para que haja apenas uma cópia de @babel/runtime para todo o projeto. Em alguns casos, sua estrutura JS já pode incluir @babel/runtime como dependência.
< script src =" dist/typesense.min.js " > </ script >ou via jsDelivr
< script src =" https://cdn.jsdelivr.net/npm/typesense@1/dist/typesense.min.js " > </ script > Leia a documentação aqui para exemplos detalhados: https://typesense.org/docs/api/
Os testes também são um bom lugar para saber como a biblioteca funciona internamente: test
Observação: ao usar esta biblioteca em um navegador, certifique-se de usar uma chave de API que permita apenas operações de pesquisa em vez da chave de API master . Consulte doc/examples/server/keys.js para obter um exemplo de como gerar uma chave de API somente de pesquisa.
Consulte Configuration.ts para obter uma lista de todas as opções de configuração do cliente.
Aqui estão alguns exemplos com comentários embutidos que mostram como usar o cliente: doc/examples
Para executar os exemplos, na raiz do repositório:
npm run typesenseServer
node doc/examples/server/bulkImport.jsSe você usa GatsbyJS para uma estrutura, temos um plug-in (que usa o Typesense-js nos bastidores) para enviar automaticamente os dados do seu site para o Typesense quando você cria seu site. Saiba mais aqui.
Se você usa o Firebase, temos uma extensão do Firebase (que usa o Typesense-js nos bastidores) para enviar automaticamente seus dados do Firestore para o Typesense. Saiba mais aqui.
Confira Typesense-InstantSearch.js (que usa typesense-js) para componentes de UI que você pode usar para construir rapidamente experiências de pesquisa instantânea poderosas.
Esta tabela refere-se à compatibilidade do servidor=>cliente. As versões mais recentes da biblioteca cliente mantêm compatibilidade retroativa com versões mais antigas da biblioteca do servidor.
| Servidor Typesense | TypeSense-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 |
Depois de verificar o repositório, execute npm install para instalar as dependências. Em seguida, execute npm test para executar o linter e os testes.
Para lançar uma nova versão, usamos o pacote np:
$ npm install --global np
$ np
# Follow instructions that np shows you
Relatórios de bugs e solicitações pull são bem-vindos no GitHub em https://github.com/typesense/typesense-js.
